Google Git
Sign in
apache / tomee-site-pub / 294f8729efbe13f29a64f7a60a72b67641434a45 / . / tomee-8.0 / javadoc / javax / ws / rs / client / Invocation.Builder.html
blob: c6eb255decfdb53c92659a24873da852dfbca184 [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>Invocation.Builder</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.Builder";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":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/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/ws/rs/client/InvocationCallback.html" title="interface in javax.ws.rs.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/ws/rs/client/Invocation.Builder.html" target="_top">Frames</a></li>
<li><a href="Invocation.Builder.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">javax.ws.rs.client</div>
<h2 title="Interface Invocation.Builder" class="title">Interface Invocation.Builder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../javax/ws/rs/client/SyncInvoker.html" title="interface in javax.ws.rs.client">SyncInvoker</a></dd>
</dl>
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="typeNameLabel">Invocation.Builder</span>
extends <a href="../../../../javax/ws/rs/client/SyncInvoker.html" title="interface in javax.ws.rs.client">SyncInvoker</a></pre>
<div class="block">A client request invocation builder.
The builder, obtained via a call to one of the <code>request(...)</code>
methods on a <a href="../../../../javax/ws/rs/client/WebTarget.html" title="interface in javax.ws.rs.client"><code>resource target</code></a>, provides methods for
preparing a client request invocation. Once the request is prepared
the invocation builder can be either used to build an <a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client"><code>Invocation</code></a>
with a generic execution interface:
<pre>
Client client = ClientBuilder.newClient();
WebTarget resourceTarget = client.target("http://examples.jaxrs.com/");
// Build a HTTP GET request that accepts "text/plain" response type
// and contains a custom HTTP header entry "Foo: bar".
Invocation invocation = resourceTarget.request("text/plain")
.header("Foo", "bar").buildGet();
// Invoke the request using generic interface
String response = invocation.invoke(String.class);
</pre>
Alternatively, one of the inherited <a href="../../../../javax/ws/rs/client/SyncInvoker.html" title="interface in javax.ws.rs.client"><code>synchronous invocation
methods</code></a> can be used to invoke the prepared request and return the server
response in a single step, e.g.:
<pre>
Client client = ClientBuilder.newClient();
WebTarget resourceTarget = client.target("http://examples.jaxrs.com/");
// Build and invoke the get request in a single step
String response = resourceTarget.request("text/plain")
.header("Foo", "bar").get(String.class);
</pre>
Once the request is fully prepared for invoking, switching to an
<a href="../../../../javax/ws/rs/client/AsyncInvoker.html" title="interface in javax.ws.rs.client"><code>asynchronous invocation</code></a> mode is possible by
calling the <a href="../../../../javax/ws/rs/client/Invocation.Builder.html#async--"><code>async()</code></a> method on the builder, e.g.:
<pre>
Client client = ClientBuilder.newClient();
WebTarget resourceTarget = client.target("http://examples.jaxrs.com/");
// Build and invoke the get request asynchronously in a single step
Future<String> response = resourceTarget.request("text/plain")
.header("Foo", "bar").async().get(String.class);
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#accept-javax.ws.rs.core.MediaType...-">accept</a></span>(<a href="../../../../javax/ws/rs/core/MediaType.html" title="class in javax.ws.rs.core">MediaType</a>...&nbsp;mediaTypes)</code>
<div class="block">Add the accepted response media types.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#accept-java.lang.String...-">accept</a></span>(java.lang.String...&nbsp;mediaTypes)</code>
<div class="block">Add the accepted response media types.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#acceptEncoding-java.lang.String...-">acceptEncoding</a></span>(java.lang.String...&nbsp;encodings)</code>
<div class="block">Add acceptable encodings.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#acceptLanguage-java.util.Locale...-">acceptLanguage</a></span>(java.util.Locale...&nbsp;locales)</code>
<div class="block">Add acceptable languages.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#acceptLanguage-java.lang.String...-">acceptLanguage</a></span>(java.lang.String...&nbsp;locales)</code>
<div class="block">Add acceptable languages.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/AsyncInvoker.html" title="interface in javax.ws.rs.client">AsyncInvoker</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#async--">async</a></span>()</code>
<div class="block">Access the asynchronous uniform request invocation interface to
asynchronously invoke the built request.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#build-java.lang.String-">build</a></span>(java.lang.String&nbsp;method)</code>
<div class="block">Build a request invocation using an arbitrary request method name.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#build-java.lang.String-javax.ws.rs.client.Entity-">build</a></span>(java.lang.String&nbsp;method,
<a href="../../../../javax/ws/rs/client/Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</code>
<div class="block">Build a request invocation using an arbitrary request method name and
request entity.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#buildDelete--">buildDelete</a></span>()</code>
<div class="block">Build a DELETE request invocation.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#buildGet--">buildGet</a></span>()</code>
<div class="block">Build a GET request invocation.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#buildPost-javax.ws.rs.client.Entity-">buildPost</a></span>(<a href="../../../../javax/ws/rs/client/Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</code>
<div class="block">Build a POST request invocation.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#buildPut-javax.ws.rs.client.Entity-">buildPut</a></span>(<a href="../../../../javax/ws/rs/client/Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</code>
<div class="block">Build a PUT request invocation.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#cacheControl-javax.ws.rs.core.CacheControl-">cacheControl</a></span>(<a href="../../../../javax/ws/rs/core/CacheControl.html" title="class in javax.ws.rs.core">CacheControl</a>&nbsp;cacheControl)</code>
<div class="block">Set the cache control data of the message.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#cookie-javax.ws.rs.core.Cookie-">cookie</a></span>(<a href="../../../../javax/ws/rs/core/Cookie.html" title="class in javax.ws.rs.core">Cookie</a>&nbsp;cookie)</code>
<div class="block">Add a cookie to be set.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#cookie-java.lang.String-java.lang.String-">cookie</a></span>(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</code>
<div class="block">Add a cookie to be set.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#header-java.lang.String-java.lang.Object-">header</a></span>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</code>
<div class="block">Add an arbitrary header.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#headers-javax.ws.rs.core.MultivaluedMap-">headers</a></span>(<a href="../../../../javax/ws/rs/core/MultivaluedMap.html" title="interface in javax.ws.rs.core">MultivaluedMap</a>&lt;java.lang.String,java.lang.Object&gt;&nbsp;headers)</code>
<div class="block">Replaces all existing headers with the newly supplied headers.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#property-java.lang.String-java.lang.Object-">property</a></span>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</code>
<div class="block">Set a new property in the context of a request represented by this invocation builder.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../javax/ws/rs/client/CompletionStageRxInvoker.html" title="interface in javax.ws.rs.client">CompletionStageRxInvoker</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#rx--">rx</a></span>()</code>
<div class="block">Access the default reactive invoker based on <code>CompletionStage</code>.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>&lt;T extends <a href="../../../../javax/ws/rs/client/RxInvoker.html" title="interface in javax.ws.rs.client">RxInvoker</a>&gt;<br>T</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#rx-java.lang.Class-">rx</a></span>(java.lang.Class&lt;T&gt;&nbsp;clazz)</code>
<div class="block">Access a reactive invoker based on a <a href="../../../../javax/ws/rs/client/RxInvoker.html" title="interface in javax.ws.rs.client"><code>RxInvoker</code></a> subclass provider.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.javax.ws.rs.client.SyncInvoker">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.ws.rs.client.<a href="../../../../javax/ws/rs/client/SyncInvoker.html" title="interface in javax.ws.rs.client">SyncInvoker</a></h3>
<code><a href="../../../../javax/ws/rs/client/SyncInvoker.html#delete--">delete</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#delete-java.lang.Class-">delete</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#delete-javax.ws.rs.core.GenericType-">delete</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#get--">get</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#get-java.lang.Class-">get</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#get-javax.ws.rs.core.GenericType-">get</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#head--">head</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#method-java.lang.String-">method</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#method-java.lang.String-java.lang.Class-">method</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#method-java.lang.String-javax.ws.rs.client.Entity-">method</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#method-java.lang.String-javax.ws.rs.client.Entity-java.lang.Class-">method</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#method-java.lang.String-javax.ws.rs.client.Entity-javax.ws.rs.core.GenericType-">method</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#method-java.lang.String-javax.ws.rs.core.GenericType-">method</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#options--">options</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#options-java.lang.Class-">options</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#options-javax.ws.rs.core.GenericType-">options</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#post-javax.ws.rs.client.Entity-">post</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#post-javax.ws.rs.client.Entity-java.lang.Class-">post</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#post-javax.ws.rs.client.Entity-javax.ws.rs.core.GenericType-">post</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#put-javax.ws.rs.client.Entity-">put</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#put-javax.ws.rs.client.Entity-java.lang.Class-">put</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#put-javax.ws.rs.client.Entity-javax.ws.rs.core.GenericType-">put</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#trace--">trace</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#trace-java.lang.Class-">trace</a>, <a href="../../../../javax/ws/rs/client/SyncInvoker.html#trace-javax.ws.rs.core.GenericType-">trace</a></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="build-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;build(java.lang.String&nbsp;method)</pre>
<div class="block">Build a request invocation using an arbitrary request method name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>method</code> - request method name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>invocation encapsulating the built request.</dd>
</dl>
</li>
</ul>
<a name="build-java.lang.String-javax.ws.rs.client.Entity-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;build(java.lang.String&nbsp;method,
<a href="../../../../javax/ws/rs/client/Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</pre>
<div class="block">Build a request invocation using an arbitrary request method name and
request entity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>method</code> - request method name.</dd>
<dd><code>entity</code> - request entity, including it's full <a href="../../../../javax/ws/rs/core/Variant.html" title="class in javax.ws.rs.core"><code>Variant</code></a> information.
Any variant-related HTTP headers previously set (namely <code>Content-Type</code>,
<code>Content-Language</code> and <code>Content-Encoding</code>) will be overwritten using
the entity variant information.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>invocation encapsulating the built request.</dd>
</dl>
</li>
</ul>
<a name="buildGet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildGet</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;buildGet()</pre>
<div class="block">Build a GET request invocation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>invocation encapsulating the built GET request.</dd>
</dl>
</li>
</ul>
<a name="buildDelete--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildDelete</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;buildDelete()</pre>
<div class="block">Build a DELETE request invocation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>invocation encapsulating the built DELETE request.</dd>
</dl>
</li>
</ul>
<a name="buildPost-javax.ws.rs.client.Entity-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildPost</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;buildPost(<a href="../../../../javax/ws/rs/client/Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</pre>
<div class="block">Build a POST request invocation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entity</code> - request entity, including it's full <a href="../../../../javax/ws/rs/core/Variant.html" title="class in javax.ws.rs.core"><code>Variant</code></a> information.
Any variant-related HTTP headers previously set (namely <code>Content-Type</code>,
<code>Content-Language</code> and <code>Content-Encoding</code>) will be overwritten using
the entity variant information.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>invocation encapsulating the built POST request.</dd>
</dl>
</li>
</ul>
<a name="buildPut-javax.ws.rs.client.Entity-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildPut</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client">Invocation</a>&nbsp;buildPut(<a href="../../../../javax/ws/rs/client/Entity.html" title="class in javax.ws.rs.client">Entity</a>&lt;?&gt;&nbsp;entity)</pre>
<div class="block">Build a PUT request invocation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entity</code> - request entity, including it's full <a href="../../../../javax/ws/rs/core/Variant.html" title="class in javax.ws.rs.core"><code>Variant</code></a> information.
Any variant-related HTTP headers previously set (namely <code>Content-Type</code>,
<code>Content-Language</code> and <code>Content-Encoding</code>) will be overwritten using
the entity variant information.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>invocation encapsulating the built PUT request.</dd>
</dl>
</li>
</ul>
<a name="async--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>async</h4>
<pre><a href="../../../../javax/ws/rs/client/AsyncInvoker.html" title="interface in javax.ws.rs.client">AsyncInvoker</a>&nbsp;async()</pre>
<div class="block">Access the asynchronous uniform request invocation interface to
asynchronously invoke the built request.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>asynchronous uniform request invocation interface.</dd>
</dl>
</li>
</ul>
<a name="accept-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;accept(java.lang.String...&nbsp;mediaTypes)</pre>
<div class="block">Add the accepted response media types.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaTypes</code> - accepted response media types.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="accept-javax.ws.rs.core.MediaType...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accept</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;accept(<a href="../../../../javax/ws/rs/core/MediaType.html" title="class in javax.ws.rs.core">MediaType</a>...&nbsp;mediaTypes)</pre>
<div class="block">Add the accepted response media types.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mediaTypes</code> - accepted response media types.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="acceptLanguage-java.util.Locale...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acceptLanguage</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;acceptLanguage(java.util.Locale...&nbsp;locales)</pre>
<div class="block">Add acceptable languages.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>locales</code> - an array of the acceptable languages.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="acceptLanguage-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acceptLanguage</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;acceptLanguage(java.lang.String...&nbsp;locales)</pre>
<div class="block">Add acceptable languages.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>locales</code> - an array of the acceptable languages.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="acceptEncoding-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>acceptEncoding</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;acceptEncoding(java.lang.String...&nbsp;encodings)</pre>
<div class="block">Add acceptable encodings.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>encodings</code> - an array of the acceptable encodings.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="cookie-javax.ws.rs.core.Cookie-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cookie</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;cookie(<a href="../../../../javax/ws/rs/core/Cookie.html" title="class in javax.ws.rs.core">Cookie</a>&nbsp;cookie)</pre>
<div class="block">Add a cookie to be set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cookie</code> - to be set.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="cookie-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cookie</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;cookie(java.lang.String&nbsp;name,
java.lang.String&nbsp;value)</pre>
<div class="block">Add a cookie to be set.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the cookie.</dd>
<dd><code>value</code> - the value of the cookie.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="cacheControl-javax.ws.rs.core.CacheControl-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cacheControl</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;cacheControl(<a href="../../../../javax/ws/rs/core/CacheControl.html" title="class in javax.ws.rs.core">CacheControl</a>&nbsp;cacheControl)</pre>
<div class="block">Set the cache control data of the message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheControl</code> - the cache control directives, if <code>null</code>
any existing cache control directives will be removed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="header-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>header</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;header(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</pre>
<div class="block">Add an arbitrary header.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the header</dd>
<dd><code>value</code> - the value of the header, the header will be serialized
using a <a href="../../../../javax/ws/rs/ext/RuntimeDelegate.HeaderDelegate.html" title="interface in javax.ws.rs.ext"><code>RuntimeDelegate.HeaderDelegate</code></a> if
one is available via <a href="../../../../javax/ws/rs/ext/RuntimeDelegate.html#createHeaderDelegate-java.lang.Class-"><code>RuntimeDelegate.createHeaderDelegate(java.lang.Class)</code></a>
for the class of <code>value</code> or using its <code>toString</code> method
if a header delegate is not available. If <code>value</code> is <code>null</code>
then all current headers of the same name will be removed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="headers-javax.ws.rs.core.MultivaluedMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>headers</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;headers(<a href="../../../../javax/ws/rs/core/MultivaluedMap.html" title="interface in javax.ws.rs.core">MultivaluedMap</a>&lt;java.lang.String,java.lang.Object&gt;&nbsp;headers)</pre>
<div class="block">Replaces all existing headers with the newly supplied headers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>headers</code> - new headers to be set, if <code>null</code> all existing
headers will be removed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated builder.</dd>
</dl>
</li>
</ul>
<a name="property-java.lang.String-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>property</h4>
<pre><a href="../../../../javax/ws/rs/client/Invocation.Builder.html" title="interface in javax.ws.rs.client">Invocation.Builder</a>&nbsp;property(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</pre>
<div class="block">Set a new property in the context of a request represented by this invocation builder.
<p>
The property is available for a later retrieval via <a href="../../../../javax/ws/rs/client/ClientRequestContext.html#getProperty-java.lang.String-"><code>ClientRequestContext.getProperty(String)</code></a>
or <a href="../../../../javax/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 builder.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/client/Invocation.html#property-java.lang.String-java.lang.Object-"><code>Invocation.property(String, Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="rx--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rx</h4>
<pre><a href="../../../../javax/ws/rs/client/CompletionStageRxInvoker.html" title="interface in javax.ws.rs.client">CompletionStageRxInvoker</a>&nbsp;rx()</pre>
<div class="block">Access the default reactive invoker based on <code>CompletionStage</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>default reactive invoker instance.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/client/Invocation.Builder.html#rx-java.lang.Class-"><code>rx(Class)</code></a></dd>
</dl>
</li>
</ul>
<a name="rx-java.lang.Class-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rx</h4>
<pre>&lt;T extends <a href="../../../../javax/ws/rs/client/RxInvoker.html" title="interface in javax.ws.rs.client">RxInvoker</a>&gt;&nbsp;T&nbsp;rx(java.lang.Class&lt;T&gt;&nbsp;clazz)</pre>
<div class="block">Access a reactive invoker based on a <a href="../../../../javax/ws/rs/client/RxInvoker.html" title="interface in javax.ws.rs.client"><code>RxInvoker</code></a> subclass provider. Note
that corresponding <a href="../../../../javax/ws/rs/client/RxInvokerProvider.html" title="interface in javax.ws.rs.client"><code>RxInvokerProvider</code></a> must be registered in the client runtime.
<p>
This method is an extension point for implementations to support other types
representing asynchronous computations.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clazz</code> - <a href="../../../../javax/ws/rs/client/RxInvoker.html" title="interface in javax.ws.rs.client"><code>RxInvoker</code></a> subclass.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>reactive invoker instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - when provider for given class is not registered.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../javax/ws/rs/core/Configurable.html#register-java.lang.Class-"><code>Configurable.register(Class)</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="../../../../javax/ws/rs/client/Invocation.html" title="interface in javax.ws.rs.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../javax/ws/rs/client/InvocationCallback.html" title="interface in javax.ws.rs.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?javax/ws/rs/client/Invocation.Builder.html" target="_top">Frames</a></li>
<li><a href="Invocation.Builder.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>