-
Notifications
You must be signed in to change notification settings - Fork 1
/
ClientEndpointConfig.Builder.html
439 lines (437 loc) · 17.7 KB
/
ClientEndpointConfig.Builder.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Sat Oct 21 15:44:48 UTC 2023 -->
<title>ClientEndpointConfig.Builder (Tyrus 2.0.5 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-10-21">
<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="ClientEndpointConfig.Builder (Tyrus 2.0.5 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/ClientEndpointConfig.Builder.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 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: </li>
<li>Nested | </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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </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> <a href="package-summary.html">jakarta.websocket</a></div>
<h2 title="Class ClientEndpointConfig.Builder" class="title">Class ClientEndpointConfig.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jakarta.websocket.ClientEndpointConfig.Builder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing interface:</dt>
<dd><a href="ClientEndpointConfig.html" title="interface in jakarta.websocket">ClientEndpointConfig</a></dd>
</dl>
<hr>
<pre>public static final class <span class="typeNameLabel">ClientEndpointConfig.Builder</span>
extends java.lang.Object</pre>
<div class="block">The ClientEndpointConfig.Builder is a class used for creating <a href="ClientEndpointConfig.html" title="interface in jakarta.websocket"><code>ClientEndpointConfig</code></a> objects for the
purposes of deploying a client endpoint. Here are some examples: Building a plain configuration with no encoders,
decoders, subprotocols or extensions. <code>
ClientEndpointConfig cec = ClientEndpointConfig.Builder.create().build();
</code>
Building a configuration with no subprotocols and a custom configurator.
<pre>
<code>
ClientEndpointConfig customCec = ClientEndpointConfig.Builder.create()
.preferredSubprotocols(mySubprotocols)
.configurator(new MyClientConfigurator())
.build();
</code>
</pre></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>dannycoward</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="ClientEndpointConfig.html" title="interface in jakarta.websocket">ClientEndpointConfig</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">Builds a configuration object using the attributes set on this builder.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#configurator(jakarta.websocket.ClientEndpointConfig.Configurator)">configurator</a></span>​(<a href="ClientEndpointConfig.Configurator.html" title="class in jakarta.websocket">ClientEndpointConfig.Configurator</a> clientEndpointConfigurator)</code></th>
<td class="colLast">
<div class="block">Sets the configurator object for the configuration this builder will build.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create()">create</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a new builder object with no subprotocols, extensions, encoders, decoders and a <code>null</code>
configurator.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#decoders(java.util.List)">decoders</a></span>​(java.util.List<java.lang.Class<? extends <a href="Decoder.html" title="interface in jakarta.websocket">Decoder</a>>> decoders)</code></th>
<td class="colLast">
<div class="block">Assign the list of decoder implementation classes the client will use.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#encoders(java.util.List)">encoders</a></span>​(java.util.List<java.lang.Class<? extends <a href="Encoder.html" title="interface in jakarta.websocket">Encoder</a>>> encoders)</code></th>
<td class="colLast">
<div class="block">Assign the list of encoder implementation classes the client will use.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#extensions(java.util.List)">extensions</a></span>​(java.util.List<<a href="Extension.html" title="interface in jakarta.websocket">Extension</a>> extensions)</code></th>
<td class="colLast">
<div class="block">Set the extensions for the configuration this builder will build.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#preferredSubprotocols(java.util.List)">preferredSubprotocols</a></span>​(java.util.List<java.lang.String> preferredSubprotocols)</code></th>
<td class="colLast">
<div class="block">Set the preferred sub protocols for the configuration this builder will build.</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 java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="create()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public static <a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a> create()</pre>
<div class="block">Creates a new builder object with no subprotocols, extensions, encoders, decoders and a <code>null</code>
configurator.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new builder object.</dd>
</dl>
</li>
</ul>
<a id="build()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public <a href="ClientEndpointConfig.html" title="interface in jakarta.websocket">ClientEndpointConfig</a> build()</pre>
<div class="block">Builds a configuration object using the attributes set on this builder.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new configuration object.</dd>
</dl>
</li>
</ul>
<a id="configurator(jakarta.websocket.ClientEndpointConfig.Configurator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configurator</h4>
<pre class="methodSignature">public <a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a> configurator​(<a href="ClientEndpointConfig.Configurator.html" title="class in jakarta.websocket">ClientEndpointConfig.Configurator</a> clientEndpointConfigurator)</pre>
<div class="block">Sets the configurator object for the configuration this builder will build.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clientEndpointConfigurator</code> - the configurator</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder instance</dd>
</dl>
</li>
</ul>
<a id="preferredSubprotocols(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preferredSubprotocols</h4>
<pre class="methodSignature">public <a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a> preferredSubprotocols​(java.util.List<java.lang.String> preferredSubprotocols)</pre>
<div class="block">Set the preferred sub protocols for the configuration this builder will build. The list is treated in order
of preference, favorite first, that this client would like to use for its sessions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>preferredSubprotocols</code> - the preferred subprotocol names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder instance</dd>
</dl>
</li>
</ul>
<a id="extensions(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extensions</h4>
<pre class="methodSignature">public <a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a> extensions​(java.util.List<<a href="Extension.html" title="interface in jakarta.websocket">Extension</a>> extensions)</pre>
<div class="block">Set the extensions for the configuration this builder will build. The list is treated in order of preference,
favorite first, that the client would like to use for its sessions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extensions</code> - the extensions</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder instance</dd>
</dl>
</li>
</ul>
<a id="encoders(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encoders</h4>
<pre class="methodSignature">public <a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a> encoders​(java.util.List<java.lang.Class<? extends <a href="Encoder.html" title="interface in jakarta.websocket">Encoder</a>>> encoders)</pre>
<div class="block">Assign the list of encoder implementation classes the client will use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>encoders</code> - the encoder implementation classes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the builder instance</dd>
</dl>
</li>
</ul>
<a id="decoders(java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>decoders</h4>
<pre class="methodSignature">public <a href="ClientEndpointConfig.Builder.html" title="class in jakarta.websocket">ClientEndpointConfig.Builder</a> decoders​(java.util.List<java.lang.Class<? extends <a href="Decoder.html" title="interface in jakarta.websocket">Decoder</a>>> decoders)</pre>
<div class="block">Assign the list of decoder implementation classes the client will use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>decoders</code> - the decoder implementation classes</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this builder 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/ClientEndpointConfig.Builder.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 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: </li>
<li>Nested | </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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright © 2012–2020 <a href="http://www.oracle.com/">Oracle Corporation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>