blob: 7d1e9fcd3cf2de03804c33820e0a12c01ea4fb59 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Wed Sep 23 17:36:24 GMT 2020 -->
<title>ClientBuilder (jakarta.ws.rs-api 3.0.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2020-09-23">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ClientBuilder (jakarta.ws.rs-api 3.0.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":10,"i6":9,"i7":9,"i8":9,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClientBuilder.html">Use</a></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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">jakarta.ws.rs.client</a></div>
<h2 title="Class ClientBuilder" class="title">Class ClientBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>jakarta.ws.rs.client.ClientBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a>&lt;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&gt;</code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">ClientBuilder</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="../core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a>&lt;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&gt;</pre>
<div class="block">Main entry point to the client API used to bootstrap <a href="Client.html" title="interface in jakarta.ws.rs.client"><code>Client</code></a> instances.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Marek Potociar</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY">JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY</a></span></code></th>
<td class="colLast">
<div class="block">Name of the property identifying the <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client"><code>ClientBuilder</code></a> implementation to be returned from
<a href="#newBuilder()"><code>newBuilder()</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ClientBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">Allows custom implementations to extend the <code>ClientBuilder</code> class.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>abstract <a href="Client.html" title="interface in jakarta.ws.rs.client">Client</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
<td class="colLast">
<div class="block">Build a new client instance using all the configuration previously specified in this client builder.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connectTimeout(long,java.util.concurrent.TimeUnit)">connectTimeout</a></span>&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;unit)</code></th>
<td class="colLast">
<div class="block">Set the connect timeout.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executorService(java.util.concurrent.ExecutorService)">executorService</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ExecutorService</a>&nbsp;executorService)</code></th>
<td class="colLast">
<div class="block">Set the client-side <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>ExecutorService</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hostnameVerifier(javax.net.ssl.HostnameVerifier)">hostnameVerifier</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/HostnameVerifier.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">HostnameVerifier</a>&nbsp;verifier)</code></th>
<td class="colLast">
<div class="block">Set the hostname verifier to be used by the client to verify the endpoint's hostname against it's identification
information.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyStore(java.security.KeyStore,char%5B%5D)">keyStore</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/KeyStore.html?is-external=true" title="class or interface in java.security" class="externalLink">KeyStore</a>&nbsp;keyStore,
char[]&nbsp;password)</code></th>
<td class="colLast">
<div class="block">Set the client-side key store.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#keyStore(java.security.KeyStore,java.lang.String)">keyStore</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/KeyStore.html?is-external=true" title="class or interface in java.security" class="externalLink">KeyStore</a>&nbsp;keyStore,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;password)</code></th>
<td class="colLast">
<div class="block">Set the client-side key store.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newBuilder()">newBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">Create a new <code>ClientBuilder</code> instance using the default client builder implementation class provided by the
JAX-RS implementation provider.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="Client.html" title="interface in jakarta.ws.rs.client">Client</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newClient()">newClient</a></span>()</code></th>
<td class="colLast">
<div class="block">Create a new <a href="Client.html" title="interface in jakarta.ws.rs.client"><code>Client</code></a> instance using the default client builder implementation class provided by the JAX-RS
implementation provider.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="Client.html" title="interface in jakarta.ws.rs.client">Client</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newClient(jakarta.ws.rs.core.Configuration)">newClient</a></span>&#8203;(<a href="../core/Configuration.html" title="interface in jakarta.ws.rs.core">Configuration</a>&nbsp;configuration)</code></th>
<td class="colLast">
<div class="block">Create a new custom-configured <a href="Client.html" title="interface in jakarta.ws.rs.client"><code>Client</code></a> instance using the default client builder implementation class provided
by the JAX-RS implementation provider.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#readTimeout(long,java.util.concurrent.TimeUnit)">readTimeout</a></span>&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;unit)</code></th>
<td class="colLast">
<div class="block">Set the read timeout.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>abstract <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#scheduledExecutorService(java.util.concurrent.ScheduledExecutorService)">scheduledExecutorService</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ScheduledExecutorService</a>&nbsp;scheduledExecutorService)</code></th>
<td class="colLast">
<div class="block">Set the client-side <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>ScheduledExecutorService</code></a>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>abstract <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sslContext(javax.net.ssl.SSLContext)">sslContext</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLContext</a>&nbsp;sslContext)</code></th>
<td class="colLast">
<div class="block">Set the SSL context that will be used when creating secured transport connections to server endpoints from
<a href="WebTarget.html" title="interface in jakarta.ws.rs.client"><code>web targets</code></a> created by the client instance that is using this SSL context.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>abstract <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trustStore(java.security.KeyStore)">trustStore</a></span>&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/KeyStore.html?is-external=true" title="class or interface in java.security" class="externalLink">KeyStore</a>&nbsp;trustStore)</code></th>
<td class="colLast">
<div class="block">Set the client-side trust store.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withConfig(jakarta.ws.rs.core.Configuration)">withConfig</a></span>&#8203;(<a href="../core/Configuration.html" title="interface in jakarta.ws.rs.core">Configuration</a>&nbsp;config)</code></th>
<td class="colLast">
<div class="block">Set the internal configuration state to an externally provided configuration state.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.jakarta.ws.rs.core.Configurable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.ws.rs.core.<a href="../core/Configurable.html" title="interface in jakarta.ws.rs.core">Configurable</a></h3>
<code><a href="../core/Configurable.html#getConfiguration()">getConfiguration</a>, <a href="../core/Configurable.html#property(java.lang.String,java.lang.Object)">property</a>, <a href="../core/Configurable.html#register(java.lang.Class)">register</a>, <a href="../core/Configurable.html#register(java.lang.Class,int)">register</a>, <a href="../core/Configurable.html#register(java.lang.Class,java.lang.Class...)">register</a>, <a href="../core/Configurable.html#register(java.lang.Class,java.util.Map)">register</a>, <a href="../core/Configurable.html#register(java.lang.Object)">register</a>, <a href="../core/Configurable.html#register(java.lang.Object,int)">register</a>, <a href="../core/Configurable.html#register(java.lang.Object,java.lang.Class...)">register</a>, <a href="../core/Configurable.html#register(java.lang.Object,java.util.Map)">register</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY</pre>
<div class="block">Name of the property identifying the <a href="ClientBuilder.html" title="class in jakarta.ws.rs.client"><code>ClientBuilder</code></a> implementation to be returned from
<a href="#newBuilder()"><code>newBuilder()</code></a>.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#jakarta.ws.rs.client.ClientBuilder.JAXRS_DEFAULT_CLIENT_BUILDER_PROPERTY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ClientBuilder</h4>
<pre>protected&nbsp;ClientBuilder()</pre>
<div class="block">Allows custom implementations to extend the <code>ClientBuilder</code> class.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="newBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBuilder</h4>
<pre class="methodSignature">public static&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;newBuilder()</pre>
<div class="block">Create a new <code>ClientBuilder</code> instance using the default client builder implementation class provided by the
JAX-RS implementation provider.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new client builder instance.</dd>
</dl>
</li>
</ul>
<a id="newClient()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newClient</h4>
<pre class="methodSignature">public static&nbsp;<a href="Client.html" title="interface in jakarta.ws.rs.client">Client</a>&nbsp;newClient()</pre>
<div class="block">Create a new <a href="Client.html" title="interface in jakarta.ws.rs.client"><code>Client</code></a> instance using the default client builder implementation class provided by the JAX-RS
implementation provider.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new client instance.</dd>
</dl>
</li>
</ul>
<a id="newClient(jakarta.ws.rs.core.Configuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newClient</h4>
<pre class="methodSignature">public static&nbsp;<a href="Client.html" title="interface in jakarta.ws.rs.client">Client</a>&nbsp;newClient&#8203;(<a href="../core/Configuration.html" title="interface in jakarta.ws.rs.core">Configuration</a>&nbsp;configuration)</pre>
<div class="block">Create a new custom-configured <a href="Client.html" title="interface in jakarta.ws.rs.client"><code>Client</code></a> instance using the default client builder implementation class provided
by the JAX-RS implementation provider.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configuration</code> - data used to provide initial configuration for the new client instance.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new configured client instance.</dd>
</dl>
</li>
</ul>
<a id="withConfig(jakarta.ws.rs.core.Configuration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withConfig</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;withConfig&#8203;(<a href="../core/Configuration.html" title="interface in jakarta.ws.rs.core">Configuration</a>&nbsp;config)</pre>
<div class="block">Set the internal configuration state to an externally provided configuration state.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - external configuration state to replace the configuration of this configurable instance.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the updated client builder instance.</dd>
</dl>
</li>
</ul>
<a id="sslContext(javax.net.ssl.SSLContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sslContext</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;sslContext&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/SSLContext.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">SSLContext</a>&nbsp;sslContext)</pre>
<div class="block">Set the SSL context that will be used when creating secured transport connections to server endpoints from
<a href="WebTarget.html" title="interface in jakarta.ws.rs.client"><code>web targets</code></a> created by the client instance that is using this SSL context. The SSL context is
expected to have all the security infrastructure initialized, including the key and trust managers.
<p>
Setting a SSL context instance resets any <a href="#keyStore(java.security.KeyStore,char%5B%5D)"><code>key store</code></a> or
<a href="#trustStore(java.security.KeyStore)"><code>trust store</code></a> values previously specified.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sslContext</code> - secure socket protocol implementation which acts as a factory for secure socket factories or
<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/SSLEngine.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink"><code>SSL engines</code></a>. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an updated client builder instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - in case the <code>sslContext</code> parameter is <code>null</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#keyStore(java.security.KeyStore,char%5B%5D)"><code>keyStore(java.security.KeyStore, char[])</code></a>,
<a href="#keyStore(java.security.KeyStore,java.lang.String)"><code>keyStore(java.security.KeyStore, String)</code></a>,
<a href="#trustStore(java.security.KeyStore)"><code>trustStore(java.security.KeyStore)</code></a></dd>
</dl>
</li>
</ul>
<a id="keyStore(java.security.KeyStore,char[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyStore</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;keyStore&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/KeyStore.html?is-external=true" title="class or interface in java.security" class="externalLink">KeyStore</a>&nbsp;keyStore,
char[]&nbsp;password)</pre>
<div class="block">Set the client-side key store. Key store contains client's private keys, and the certificates with their
corresponding public keys.
<p>
Setting a key store instance resets any <a href="#sslContext(javax.net.ssl.SSLContext)"><code>SSL context instance</code></a> value
previously specified.
</p>
<p>
Note that a custom key store is only required if you want to enable a custom setup of a 2-way SSL connections (client
certificate authentication).
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyStore</code> - client-side key store. Must not be <code>null</code>.</dd>
<dd><code>password</code> - client key password. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an updated client builder instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - in case any of the supplied parameters is <code>null</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#sslContext(javax.net.ssl.SSLContext)"><code>sslContext(javax.net.ssl.SSLContext)</code></a>,
<a href="#keyStore(java.security.KeyStore,java.lang.String)"><code>keyStore(java.security.KeyStore, String)</code></a>,
<a href="#trustStore(java.security.KeyStore)"><code>trustStore(java.security.KeyStore)</code></a></dd>
</dl>
</li>
</ul>
<a id="keyStore(java.security.KeyStore,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>keyStore</h4>
<pre class="methodSignature">public&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;keyStore&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/KeyStore.html?is-external=true" title="class or interface in java.security" class="externalLink">KeyStore</a>&nbsp;keyStore,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;password)</pre>
<div class="block">Set the client-side key store. Key store contains client's private keys, and the certificates with their
corresponding public keys.
<p>
Setting a key store instance resets any <a href="#sslContext(javax.net.ssl.SSLContext)"><code>SSL context instance</code></a> value
previously specified.
</p>
<p>
Note that for improved security of working with password data and avoid storing passwords in Java string objects, the
<a href="#keyStore(java.security.KeyStore,char%5B%5D)"><code>keyStore(java.security.KeyStore, char[])</code></a> version of the method can be utilized. Also note that a custom key
store is only required if you want to enable a custom setup of a 2-way SSL connections (client certificate
authentication).
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>keyStore</code> - client-side key store. Must not be <code>null</code>.</dd>
<dd><code>password</code> - client key password. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an updated client builder instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - in case any of the supplied parameters is <code>null</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#sslContext(javax.net.ssl.SSLContext)"><code>sslContext(javax.net.ssl.SSLContext)</code></a>,
<a href="#keyStore(java.security.KeyStore,char%5B%5D)"><code>keyStore(java.security.KeyStore, char[])</code></a>,
<a href="#trustStore(java.security.KeyStore)"><code>trustStore(java.security.KeyStore)</code></a></dd>
</dl>
</li>
</ul>
<a id="trustStore(java.security.KeyStore)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trustStore</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;trustStore&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/security/KeyStore.html?is-external=true" title="class or interface in java.security" class="externalLink">KeyStore</a>&nbsp;trustStore)</pre>
<div class="block">Set the client-side trust store. Trust store is expected to contain certificates from other parties the client is you
expect to communicate with, or from Certificate Authorities that are trusted to identify other parties.
<p>
Setting a trust store instance resets any <a href="#sslContext(javax.net.ssl.SSLContext)"><code>SSL context instance</code></a> value
previously specified.
</p>
<p>
In case a custom trust store or custom SSL context is not specified, the trust management will be configured to use
the default Java runtime settings.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>trustStore</code> - client-side trust store. Must not be <code>null</code>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an updated client builder instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - in case the supplied trust store parameter is <code>null</code>.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="#sslContext(javax.net.ssl.SSLContext)"><code>sslContext(javax.net.ssl.SSLContext)</code></a>,
<a href="#keyStore(java.security.KeyStore,char%5B%5D)"><code>keyStore(java.security.KeyStore, char[])</code></a>,
<a href="#keyStore(java.security.KeyStore,java.lang.String)"><code>keyStore(java.security.KeyStore, String)</code></a></dd>
</dl>
</li>
</ul>
<a id="hostnameVerifier(javax.net.ssl.HostnameVerifier)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hostnameVerifier</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;hostnameVerifier&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/HostnameVerifier.html?is-external=true" title="class or interface in javax.net.ssl" class="externalLink">HostnameVerifier</a>&nbsp;verifier)</pre>
<div class="block">Set the hostname verifier to be used by the client to verify the endpoint's hostname against it's identification
information.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>verifier</code> - hostname verifier.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an updated client builder instance.</dd>
</dl>
</li>
</ul>
<a id="executorService(java.util.concurrent.ExecutorService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executorService</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;executorService&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ExecutorService</a>&nbsp;executorService)</pre>
<div class="block">Set the client-side <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>ExecutorService</code></a>.
<p>
Provided executor service will be used for executing asynchronous tasks.
<p>
When running in a Jakarta EE container, implementations are required to use the container-managed executor service by
default. In Java SE, the default is implementation-specific. In either case, calling this method will override the
default.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>executorService</code> - executor service to be used for async invocations.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an updated client builder instance.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="Invocation.Builder.html#async()"><code>Invocation.Builder.async()</code></a>,
<a href="Invocation.Builder.html#rx()"><code>Invocation.Builder.rx()</code></a>,
<a href="RxInvokerProvider.html#getRxInvoker(jakarta.ws.rs.client.SyncInvoker,java.util.concurrent.ExecutorService)"><code>RxInvokerProvider.getRxInvoker(SyncInvoker, ExecutorService)</code></a></dd>
</dl>
</li>
</ul>
<a id="scheduledExecutorService(java.util.concurrent.ScheduledExecutorService)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduledExecutorService</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;scheduledExecutorService&#8203;(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">ScheduledExecutorService</a>&nbsp;scheduledExecutorService)</pre>
<div class="block">Set the client-side <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>ScheduledExecutorService</code></a>.
<p>
Provided executor service will be used for executing scheduled asynchronous tasks.
<p>
When running in a Jakarta EE container, implementations are required to use the container-managed scheduled executor
service by default. In Java SE the default is implementation-specific. In either case, calling this method will
override the default.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scheduledExecutorService</code> - executor service to be used for scheduled async invocations.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an updated client builder instance.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../sse/SseEventSource.Builder.html#reconnectingEvery(long,java.util.concurrent.TimeUnit)"><code>SseEventSource.Builder.reconnectingEvery(long, TimeUnit)</code></a></dd>
</dl>
</li>
</ul>
<a id="connectTimeout(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectTimeout</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;connectTimeout&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;unit)</pre>
<div class="block">Set the connect timeout.
<p>
Value <code>0</code> represents infinity. Negative values are not allowed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - the maximum time to wait.</dd>
<dd><code>unit</code> - the time unit of the timeout argument.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an updated client builder instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - when the value is negative.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
<a id="readTimeout(long,java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readTimeout</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="ClientBuilder.html" title="class in jakarta.ws.rs.client">ClientBuilder</a>&nbsp;readTimeout&#8203;(long&nbsp;timeout,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">TimeUnit</a>&nbsp;unit)</pre>
<div class="block">Set the read timeout.
<p>
The value is the timeout to read a response. If the server doesn't respond within the defined timeframe,
<a href="../ProcessingException.html" title="class in jakarta.ws.rs"><code>ProcessingException</code></a> is thrown with <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeoutException.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>TimeoutException</code></a> as a cause.
<p>
Value <code>0</code> represents infinity. Negative values are not allowed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - the maximum time to wait.</dd>
<dd><code>unit</code> - the time unit of the timeout argument.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an updated client builder instance.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalArgumentException</a></code> - when the value is negative.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.1</dd>
</dl>
</li>
</ul>
<a id="build()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public abstract&nbsp;<a href="Client.html" title="interface in jakarta.ws.rs.client">Client</a>&nbsp;build()</pre>
<div class="block">Build a new client instance using all the configuration previously specified in this client builder.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new client instance.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClientBuilder.html">Use</a></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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small><p align="left">Copyright &#169; 2018, 2020 Eclipse Foundation.<br>Use is subject to <a href="../../../../resources/EFSL.html" target="_top">license terms</a>.</small></p>
</footer>
</body>
</html>