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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_352) on Wed Jan 25 17:31:45 CET 2023 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UnifiedServerSocket (Apache ZooKeeper - Server 3.8.1 API)</title>
<meta name="date" content="2023-01-25">
<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="UnifiedServerSocket (Apache ZooKeeper - Server 3.8.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/UnifiedServerSocket.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">
<li><a href="../../../../../org/apache/zookeeper/server/quorum/SyncThrottleException.html" title="class in org.apache.zookeeper.server.quorum"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/zookeeper/server/quorum/UnifiedServerSocket.UnifiedSocket.html" title="class in org.apache.zookeeper.server.quorum"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/zookeeper/server/quorum/UnifiedServerSocket.html" target="_top">Frames</a></li>
<li><a href="UnifiedServerSocket.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.zookeeper.server.quorum</div>
<h2 title="Class UnifiedServerSocket" class="title">Class UnifiedServerSocket</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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true" title="class or interface in java.net">java.net.ServerSocket</a></li>
<li>
<ul class="inheritance">
<li>org.apache.zookeeper.server.quorum.UnifiedServerSocket</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">UnifiedServerSocket</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true" title="class or interface in java.net">ServerSocket</a></pre>
<div class="block">A ServerSocket that can act either as a regular ServerSocket, as a SSLServerSocket, or as both, depending on
the constructor parameters and on the type of client (TLS or plaintext) that connects to it.
The constructors have the same signature as constructors of ServerSocket, with the addition of two parameters
at the beginning:
<ul>
<li>X509Util - provides the SSL context to construct a secure socket when a client connects with TLS.</li>
<li>boolean allowInsecureConnection - when true, acts as a hybrid server socket (plaintext / TLS). When
false, acts as a SSLServerSocket (rejects plaintext connections).</li>
</ul>
The <code>!allowInsecureConnection</code> mode is needed so we can update the SSLContext (in particular, the
key store and/or trust store) without having to re-create the server socket. By starting with a plaintext socket
and delaying the upgrade to TLS until after a client has connected and begins a handshake, we can keep the same
UnifiedServerSocket instance around, and replace the default SSLContext in the provided X509Util when the key store
and/or trust store file changes on disk.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/UnifiedServerSocket.UnifiedSocket.html" title="class in org.apache.zookeeper.server.quorum">UnifiedServerSocket.UnifiedSocket</a></span></code>
<div class="block">The result of calling accept() on a UnifiedServerSocket.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/UnifiedServerSocket.html#UnifiedServerSocket-org.apache.zookeeper.common.X509Util-boolean-">UnifiedServerSocket</a></span>(<a href="../../../../../org/apache/zookeeper/common/X509Util.html" title="class in org.apache.zookeeper.common">X509Util</a> x509Util,
boolean allowInsecureConnection)</code>
<div class="block">Creates an unbound unified server socket by calling <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket--" title="class or interface in java.net"><code>ServerSocket()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/UnifiedServerSocket.html#UnifiedServerSocket-org.apache.zookeeper.common.X509Util-boolean-int-">UnifiedServerSocket</a></span>(<a href="../../../../../org/apache/zookeeper/common/X509Util.html" title="class in org.apache.zookeeper.common">X509Util</a> x509Util,
boolean allowInsecureConnection,
int port)</code>
<div class="block">Creates a unified server socket bound to the specified port by calling <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket-int-" title="class or interface in java.net"><code>ServerSocket(int)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/UnifiedServerSocket.html#UnifiedServerSocket-org.apache.zookeeper.common.X509Util-boolean-int-int-">UnifiedServerSocket</a></span>(<a href="../../../../../org/apache/zookeeper/common/X509Util.html" title="class in org.apache.zookeeper.common">X509Util</a> x509Util,
boolean allowInsecureConnection,
int port,
int backlog)</code>
<div class="block">Creates a unified server socket bound to the specified port, with the specified backlog, by calling
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket-int-int-" title="class or interface in java.net"><code>ServerSocket(int, int)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/UnifiedServerSocket.html#UnifiedServerSocket-org.apache.zookeeper.common.X509Util-boolean-int-int-java.net.InetAddress-">UnifiedServerSocket</a></span>(<a href="../../../../../org/apache/zookeeper/common/X509Util.html" title="class in org.apache.zookeeper.common">X509Util</a> x509Util,
boolean allowInsecureConnection,
int port,
int backlog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> bindAddr)</code>
<div class="block">Creates a unified server socket bound to the specified port, with the specified backlog, and local IP address
to bind to, by calling <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket-int-int-java.net.InetAddress-" title="class or interface in java.net"><code>ServerSocket(int, int, InetAddress)</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/zookeeper/server/quorum/UnifiedServerSocket.html#accept--">accept</a></span>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.net.ServerSocket">
<!-- -->
</a>
<h3>Methods inherited from class java.net.<a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true" title="class or interface in java.net">ServerSocket</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#bind-java.net.SocketAddress-" title="class or interface in java.net">bind</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#bind-java.net.SocketAddress-int-" title="class or interface in java.net">bind</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#close--" title="class or interface in java.net">close</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#getChannel--" title="class or interface in java.net">getChannel</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#getInetAddress--" title="class or interface in java.net">getInetAddress</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#getLocalPort--" title="class or interface in java.net">getLocalPort</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#getLocalSocketAddress--" title="class or interface in java.net">getLocalSocketAddress</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#getReceiveBufferSize--" title="class or interface in java.net">getReceiveBufferSize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#getReuseAddress--" title="class or interface in java.net">getReuseAddress</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#getSoTimeout--" title="class or interface in java.net">getSoTimeout</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#implAccept-java.net.Socket-" title="class or interface in java.net">implAccept</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#isBound--" title="class or interface in java.net">isBound</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#isClosed--" title="class or interface in java.net">isClosed</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#setPerformancePreferences-int-int-int-" title="class or interface in java.net">setPerformancePreferences</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#setReceiveBufferSize-int-" title="class or interface in java.net">setReceiveBufferSize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#setReuseAddress-boolean-" title="class or interface in java.net">setReuseAddress</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#setSocketFactory-java.net.SocketImplFactory-" title="class or interface in java.net">setSocketFactory</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#setSoTimeout-int-" title="class or interface in java.net">setSoTimeout</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#toString--" title="class or interface in java.net">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">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">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">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">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">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">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">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">notifyAll</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">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">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">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="UnifiedServerSocket-org.apache.zookeeper.common.X509Util-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UnifiedServerSocket</h4>
<pre>public UnifiedServerSocket(<a href="../../../../../org/apache/zookeeper/common/X509Util.html" title="class in org.apache.zookeeper.common">X509Util</a> x509Util,
boolean allowInsecureConnection)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates an unbound unified server socket by calling <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket--" title="class or interface in java.net"><code>ServerSocket()</code></a>.
Secure client connections will be upgraded to TLS once this socket detects the ClientHello message (start of a
TLS handshake). Plaintext client connections will either be accepted or rejected depending on the value of
the <code>allowInsecureConnection</code> parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>x509Util</code> - the X509Util that provides the SSLContext to use for secure connections.</dd>
<dd><code>allowInsecureConnection</code> - if true, accept plaintext connections, otherwise close them.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket--" title="class or interface in java.net"><code>ServerSocket()</code></a> throws.</dd>
</dl>
</li>
</ul>
<a name="UnifiedServerSocket-org.apache.zookeeper.common.X509Util-boolean-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UnifiedServerSocket</h4>
<pre>public UnifiedServerSocket(<a href="../../../../../org/apache/zookeeper/common/X509Util.html" title="class in org.apache.zookeeper.common">X509Util</a> x509Util,
boolean allowInsecureConnection,
int port)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a unified server socket bound to the specified port by calling <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket-int-" title="class or interface in java.net"><code>ServerSocket(int)</code></a>.
Secure client connections will be upgraded to TLS once this socket detects the ClientHello message (start of a
TLS handshake). Plaintext client connections will either be accepted or rejected depending on the value of
the <code>allowInsecureConnection</code> parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>x509Util</code> - the X509Util that provides the SSLContext to use for secure connections.</dd>
<dd><code>allowInsecureConnection</code> - if true, accept plaintext connections, otherwise close them.</dd>
<dd><code>port</code> - the port number, or <code>0</code> to use a port number that is automatically allocated.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket-int-" title="class or interface in java.net"><code>ServerSocket(int)</code></a> throws.</dd>
</dl>
</li>
</ul>
<a name="UnifiedServerSocket-org.apache.zookeeper.common.X509Util-boolean-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UnifiedServerSocket</h4>
<pre>public UnifiedServerSocket(<a href="../../../../../org/apache/zookeeper/common/X509Util.html" title="class in org.apache.zookeeper.common">X509Util</a> x509Util,
boolean allowInsecureConnection,
int port,
int backlog)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a unified server socket bound to the specified port, with the specified backlog, by calling
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket-int-int-" title="class or interface in java.net"><code>ServerSocket(int, int)</code></a>.
Secure client connections will be upgraded to TLS once this socket detects the ClientHello message (start of a
TLS handshake). Plaintext client connections will either be accepted or rejected depending on the value of
the <code>allowInsecureConnection</code> parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>x509Util</code> - the X509Util that provides the SSLContext to use for secure connections.</dd>
<dd><code>allowInsecureConnection</code> - if true, accept plaintext connections, otherwise close them.</dd>
<dd><code>port</code> - the port number, or <code>0</code> to use a port number that is automatically allocated.</dd>
<dd><code>backlog</code> - requested maximum length of the queue of incoming connections.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket-int-int-" title="class or interface in java.net"><code>ServerSocket(int, int)</code></a> throws.</dd>
</dl>
</li>
</ul>
<a name="UnifiedServerSocket-org.apache.zookeeper.common.X509Util-boolean-int-int-java.net.InetAddress-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UnifiedServerSocket</h4>
<pre>public UnifiedServerSocket(<a href="../../../../../org/apache/zookeeper/common/X509Util.html" title="class in org.apache.zookeeper.common">X509Util</a> x509Util,
boolean allowInsecureConnection,
int port,
int backlog,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</a> bindAddr)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates a unified server socket bound to the specified port, with the specified backlog, and local IP address
to bind to, by calling <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket-int-int-java.net.InetAddress-" title="class or interface in java.net"><code>ServerSocket(int, int, InetAddress)</code></a>.
Secure client connections will be upgraded to TLS once this socket detects the ClientHello message (start of a
TLS handshake). Plaintext client connections will either be accepted or rejected depending on the value of
the <code>allowInsecureConnection</code> parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>x509Util</code> - the X509Util that provides the SSLContext to use for secure connections.</dd>
<dd><code>allowInsecureConnection</code> - if true, accept plaintext connections, otherwise close them.</dd>
<dd><code>port</code> - the port number, or <code>0</code> to use a port number that is automatically allocated.</dd>
<dd><code>backlog</code> - requested maximum length of the queue of incoming connections.</dd>
<dd><code>bindAddr</code> - the local InetAddress the server will bind to.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if <a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#ServerSocket-int-int-java.net.InetAddress-" title="class or interface in java.net"><code>ServerSocket(int, int, InetAddress)</code></a> throws.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="accept--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>accept</h4>
<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/Socket.html?is-external=true" title="class or interface in java.net">Socket</a> accept()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true#accept--" title="class or interface in java.net">accept</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/ServerSocket.html?is-external=true" title="class or interface in java.net">ServerSocket</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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="class-use/UnifiedServerSocket.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">
<li><a href="../../../../../org/apache/zookeeper/server/quorum/SyncThrottleException.html" title="class in org.apache.zookeeper.server.quorum"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/zookeeper/server/quorum/UnifiedServerSocket.UnifiedSocket.html" title="class in org.apache.zookeeper.server.quorum"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/zookeeper/server/quorum/UnifiedServerSocket.html" target="_top">Frames</a></li>
<li><a href="UnifiedServerSocket.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2008–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
|
