-
Notifications
You must be signed in to change notification settings - Fork 1
/
AnnotatedEndpoint.html
537 lines (536 loc) · 29.2 KB
/
AnnotatedEndpoint.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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.2) on Sat Oct 21 15:44:48 UTC 2023 -->
<title>AnnotatedEndpoint (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="AnnotatedEndpoint (Tyrus 2.0.5 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":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/AnnotatedEndpoint.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">org.glassfish.tyrus.core</a></div>
<h2 title="Class AnnotatedEndpoint" class="title">Class AnnotatedEndpoint</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../jakarta/websocket/Endpoint.html" title="class in jakarta.websocket">jakarta.websocket.Endpoint</a></li>
<li>
<ul class="inheritance">
<li>org.glassfish.tyrus.core.AnnotatedEndpoint</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">AnnotatedEndpoint</span>
extends <a href="../../../../jakarta/websocket/Endpoint.html" title="class in jakarta.websocket">Endpoint</a></pre>
<div class="block"><a href="../../../../jakarta/websocket/Endpoint.html" title="class in jakarta.websocket"><code>Endpoint</code></a> descendant which represents deployed annotated endpoint.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Martin Matula, Stepan Kopriva, Pavel Bucek</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>static <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core">AnnotatedEndpoint</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromClass(java.lang.Class,org.glassfish.tyrus.core.ComponentProviderService,boolean,int,org.glassfish.tyrus.core.ErrorCollector,org.glassfish.tyrus.core.monitoring.EndpointEventListener)">fromClass</a></span>​(java.lang.Class<?> annotatedClass,
<a href="ComponentProviderService.html" title="class in org.glassfish.tyrus.core">ComponentProviderService</a> componentProvider,
boolean isServerEndpoint,
int incomingBufferSize,
<a href="ErrorCollector.html" title="class in org.glassfish.tyrus.core">ErrorCollector</a> collector,
<a href="monitoring/EndpointEventListener.html" title="interface in org.glassfish.tyrus.core.monitoring">EndpointEventListener</a> endpointEventListener)</code></th>
<td class="colLast">
<div class="block">Create <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core"><code>AnnotatedEndpoint</code></a> from class.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core">AnnotatedEndpoint</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromClass(java.lang.Class,org.glassfish.tyrus.core.ComponentProviderService,boolean,int,org.glassfish.tyrus.core.ErrorCollector,org.glassfish.tyrus.core.monitoring.EndpointEventListener,java.util.Set)">fromClass</a></span>​(java.lang.Class<?> annotatedClass,
<a href="ComponentProviderService.html" title="class in org.glassfish.tyrus.core">ComponentProviderService</a> componentProvider,
boolean isServerEndpoint,
int incomingBufferSize,
<a href="ErrorCollector.html" title="class in org.glassfish.tyrus.core">ErrorCollector</a> collector,
<a href="monitoring/EndpointEventListener.html" title="interface in org.glassfish.tyrus.core.monitoring">EndpointEventListener</a> endpointEventListener,
java.util.Set<<a href="../../../../jakarta/websocket/Extension.html" title="interface in jakarta.websocket">Extension</a>> extensions)</code></th>
<td class="colLast">
<div class="block">Create <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core"><code>AnnotatedEndpoint</code></a> from class.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core">AnnotatedEndpoint</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromInstance(java.lang.Object,org.glassfish.tyrus.core.ComponentProviderService,boolean,int,org.glassfish.tyrus.core.ErrorCollector)">fromInstance</a></span>​(java.lang.Object annotatedInstance,
<a href="ComponentProviderService.html" title="class in org.glassfish.tyrus.core">ComponentProviderService</a> componentProvider,
boolean isServerEndpoint,
int incomingBufferSize,
<a href="ErrorCollector.html" title="class in org.glassfish.tyrus.core">ErrorCollector</a> collector)</code></th>
<td class="colLast">
<div class="block">Create <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core"><code>AnnotatedEndpoint</code></a> from instance.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core">AnnotatedEndpoint</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromInstance(java.lang.Object,org.glassfish.tyrus.core.ComponentProviderService,boolean,int,org.glassfish.tyrus.core.ErrorCollector,java.util.Set)">fromInstance</a></span>​(java.lang.Object annotatedInstance,
<a href="ComponentProviderService.html" title="class in org.glassfish.tyrus.core">ComponentProviderService</a> componentProvider,
boolean isServerEndpoint,
int incomingBufferSize,
<a href="ErrorCollector.html" title="class in org.glassfish.tyrus.core">ErrorCollector</a> collector,
java.util.Set<<a href="../../../../jakarta/websocket/Extension.html" title="interface in jakarta.websocket">Extension</a>> extensions)</code></th>
<td class="colLast">
<div class="block">Create <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core"><code>AnnotatedEndpoint</code></a> from instance.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../jakarta/websocket/EndpointConfig.html" title="interface in jakarta.websocket">EndpointConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEndpointConfig()">getEndpointConfig</a></span>()</code></th>
<td class="colLast"> </td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onClose(jakarta.websocket.Session,jakarta.websocket.CloseReason)">onClose</a></span>​(<a href="../../../../jakarta/websocket/Session.html" title="interface in jakarta.websocket">Session</a> session,
<a href="../../../../jakarta/websocket/CloseReason.html" title="class in jakarta.websocket">CloseReason</a> closeReason)</code></th>
<td class="colLast">
<div class="block">This method is called immediately prior to the session with the remote peer being closed.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onError(jakarta.websocket.Session,java.lang.Throwable)">onError</a></span>​(<a href="../../../../jakarta/websocket/Session.html" title="interface in jakarta.websocket">Session</a> session,
java.lang.Throwable thr)</code></th>
<td class="colLast">
<div class="block">Developers may implement this method when the web socket session creates some kind of error that is not modeled
in the web socket protocol.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onOpen(jakarta.websocket.Session,jakarta.websocket.EndpointConfig)">onOpen</a></span>​(<a href="../../../../jakarta/websocket/Session.html" title="interface in jakarta.websocket">Session</a> session,
<a href="../../../../jakarta/websocket/EndpointConfig.html" title="interface in jakarta.websocket">EndpointConfig</a> configuration)</code></th>
<td class="colLast">
<div class="block">Developers must implement this method to be notified when a new conversation has just begun.</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="fromClass(java.lang.Class,org.glassfish.tyrus.core.ComponentProviderService,boolean,int,org.glassfish.tyrus.core.ErrorCollector,org.glassfish.tyrus.core.monitoring.EndpointEventListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromClass</h4>
<pre class="methodSignature">public static <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core">AnnotatedEndpoint</a> fromClass​(java.lang.Class<?> annotatedClass,
<a href="ComponentProviderService.html" title="class in org.glassfish.tyrus.core">ComponentProviderService</a> componentProvider,
boolean isServerEndpoint,
int incomingBufferSize,
<a href="ErrorCollector.html" title="class in org.glassfish.tyrus.core">ErrorCollector</a> collector,
<a href="monitoring/EndpointEventListener.html" title="interface in org.glassfish.tyrus.core.monitoring">EndpointEventListener</a> endpointEventListener)</pre>
<div class="block">Create <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core"><code>AnnotatedEndpoint</code></a> from class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>annotatedClass</code> - annotated class.</dd>
<dd><code>componentProvider</code> - used for instantiating.</dd>
<dd><code>isServerEndpoint</code> - <code>true</code> iff annotated endpoint is deployed on server side.</dd>
<dd><code>incomingBufferSize</code> - size limit of the incoming buffer.</dd>
<dd><code>collector</code> - error collector.</dd>
<dd><code>endpointEventListener</code> - listener of monitored endpoint events.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new instance.</dd>
</dl>
</li>
</ul>
<a id="fromClass(java.lang.Class,org.glassfish.tyrus.core.ComponentProviderService,boolean,int,org.glassfish.tyrus.core.ErrorCollector,org.glassfish.tyrus.core.monitoring.EndpointEventListener,java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromClass</h4>
<pre class="methodSignature">public static <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core">AnnotatedEndpoint</a> fromClass​(java.lang.Class<?> annotatedClass,
<a href="ComponentProviderService.html" title="class in org.glassfish.tyrus.core">ComponentProviderService</a> componentProvider,
boolean isServerEndpoint,
int incomingBufferSize,
<a href="ErrorCollector.html" title="class in org.glassfish.tyrus.core">ErrorCollector</a> collector,
<a href="monitoring/EndpointEventListener.html" title="interface in org.glassfish.tyrus.core.monitoring">EndpointEventListener</a> endpointEventListener,
java.util.Set<<a href="../../../../jakarta/websocket/Extension.html" title="interface in jakarta.websocket">Extension</a>> extensions)</pre>
<div class="block">Create <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core"><code>AnnotatedEndpoint</code></a> from class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>annotatedClass</code> - annotated class.</dd>
<dd><code>componentProvider</code> - used for instantiating.</dd>
<dd><code>isServerEndpoint</code> - <code>true</code> iff annotated endpoint is deployed on server side.</dd>
<dd><code>incomingBufferSize</code> - size limit of the incoming buffer.</dd>
<dd><code>collector</code> - error collector.</dd>
<dd><code>endpointEventListener</code> - listener of monitored endpoint events.</dd>
<dd><code>extensions</code> - installed extentions.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new instance.</dd>
</dl>
</li>
</ul>
<a id="fromInstance(java.lang.Object,org.glassfish.tyrus.core.ComponentProviderService,boolean,int,org.glassfish.tyrus.core.ErrorCollector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromInstance</h4>
<pre class="methodSignature">public static <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core">AnnotatedEndpoint</a> fromInstance​(java.lang.Object annotatedInstance,
<a href="ComponentProviderService.html" title="class in org.glassfish.tyrus.core">ComponentProviderService</a> componentProvider,
boolean isServerEndpoint,
int incomingBufferSize,
<a href="ErrorCollector.html" title="class in org.glassfish.tyrus.core">ErrorCollector</a> collector)</pre>
<div class="block">Create <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core"><code>AnnotatedEndpoint</code></a> from instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>annotatedInstance</code> - annotated instance.</dd>
<dd><code>componentProvider</code> - used for instantiating.</dd>
<dd><code>isServerEndpoint</code> - <code>true</code> iff annotated endpoint is deployed on server side.</dd>
<dd><code>incomingBufferSize</code> - size limit of the incoming buffer</dd>
<dd><code>collector</code> - error collector.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new instance.</dd>
</dl>
</li>
</ul>
<a id="fromInstance(java.lang.Object,org.glassfish.tyrus.core.ComponentProviderService,boolean,int,org.glassfish.tyrus.core.ErrorCollector,java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromInstance</h4>
<pre class="methodSignature">public static <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core">AnnotatedEndpoint</a> fromInstance​(java.lang.Object annotatedInstance,
<a href="ComponentProviderService.html" title="class in org.glassfish.tyrus.core">ComponentProviderService</a> componentProvider,
boolean isServerEndpoint,
int incomingBufferSize,
<a href="ErrorCollector.html" title="class in org.glassfish.tyrus.core">ErrorCollector</a> collector,
java.util.Set<<a href="../../../../jakarta/websocket/Extension.html" title="interface in jakarta.websocket">Extension</a>> extensions)</pre>
<div class="block">Create <a href="AnnotatedEndpoint.html" title="class in org.glassfish.tyrus.core"><code>AnnotatedEndpoint</code></a> from instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>annotatedInstance</code> - annotated instance.</dd>
<dd><code>componentProvider</code> - used for instantiating.</dd>
<dd><code>isServerEndpoint</code> - <code>true</code> iff annotated endpoint is deployed on server side.</dd>
<dd><code>incomingBufferSize</code> - size limit of the incoming buffer</dd>
<dd><code>collector</code> - error collector.</dd>
<dd><code>extensions</code> - installed extentions.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>new instance.</dd>
</dl>
</li>
</ul>
<a id="onClose(jakarta.websocket.Session,jakarta.websocket.CloseReason)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onClose</h4>
<pre class="methodSignature">public void onClose​(<a href="../../../../jakarta/websocket/Session.html" title="interface in jakarta.websocket">Session</a> session,
<a href="../../../../jakarta/websocket/CloseReason.html" title="class in jakarta.websocket">CloseReason</a> closeReason)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../jakarta/websocket/Endpoint.html#onClose(jakarta.websocket.Session,jakarta.websocket.CloseReason)">Endpoint</a></code></span></div>
<div class="block">This method is called immediately prior to the session with the remote peer being closed. It is called whether
the session is being closed because the remote peer initiated a close and sent a close frame, or whether the
local websocket container or this endpoint requests to close the session. The developer may take this last
opportunity to retrieve session attributes such as the ID, or any application data it holds before it becomes
unavailable after the completion of the method. Developers should not attempt to modify the session from within
this method, or send new messages from this call as the underlying connection will not be able to send them at
this stage.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../jakarta/websocket/Endpoint.html#onClose(jakarta.websocket.Session,jakarta.websocket.CloseReason)">onClose</a></code> in class <code><a href="../../../../jakarta/websocket/Endpoint.html" title="class in jakarta.websocket">Endpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session about to be closed.</dd>
<dd><code>closeReason</code> - the reason the session was closed.</dd>
</dl>
</li>
</ul>
<a id="onError(jakarta.websocket.Session,java.lang.Throwable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onError</h4>
<pre class="methodSignature">public void onError​(<a href="../../../../jakarta/websocket/Session.html" title="interface in jakarta.websocket">Session</a> session,
java.lang.Throwable thr)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../jakarta/websocket/Endpoint.html#onError(jakarta.websocket.Session,java.lang.Throwable)">Endpoint</a></code></span></div>
<div class="block">Developers may implement this method when the web socket session creates some kind of error that is not modeled
in the web socket protocol. This may for example be a notification that an incoming message is too big to handle,
or that the incoming message could not be encoded.
<p>
There are a number of categories of exception that this method is (currently) defined to handle:
<ul>
<li>connection problems, for example, a socket failure that occurs before the web socket connection can be
formally closed. These are modeled as <a href="../../../../jakarta/websocket/SessionException.html" title="class in jakarta.websocket"><code>SessionException</code></a>s</li>
<li>runtime errors thrown by developer created message handlers calls.</li>
<li>conversion errors encoding incoming messages before any message handler has been called. These are modeled as
<a href="../../../../jakarta/websocket/DecodeException.html" title="class in jakarta.websocket"><code>DecodeException</code></a>s</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../jakarta/websocket/Endpoint.html#onError(jakarta.websocket.Session,java.lang.Throwable)">onError</a></code> in class <code><a href="../../../../jakarta/websocket/Endpoint.html" title="class in jakarta.websocket">Endpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session in use when the error occurs.</dd>
<dd><code>thr</code> - the throwable representing the problem.</dd>
</dl>
</li>
</ul>
<a id="getEndpointConfig()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndpointConfig</h4>
<pre class="methodSignature">public <a href="../../../../jakarta/websocket/EndpointConfig.html" title="interface in jakarta.websocket">EndpointConfig</a> getEndpointConfig()</pre>
</li>
</ul>
<a id="onOpen(jakarta.websocket.Session,jakarta.websocket.EndpointConfig)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onOpen</h4>
<pre class="methodSignature">public void onOpen​(<a href="../../../../jakarta/websocket/Session.html" title="interface in jakarta.websocket">Session</a> session,
<a href="../../../../jakarta/websocket/EndpointConfig.html" title="interface in jakarta.websocket">EndpointConfig</a> configuration)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../jakarta/websocket/Endpoint.html#onOpen(jakarta.websocket.Session,jakarta.websocket.EndpointConfig)">Endpoint</a></code></span></div>
<div class="block">Developers must implement this method to be notified when a new conversation has just begun.
<p>
Note:
<ul>
<li>It is permitted to send messages from this method.</li>
<li>It is permitted to add <a href="../../../../jakarta/websocket/MessageHandler.html" title="interface in jakarta.websocket"><code>MessageHandler</code></a>s from this method. No messages will be
mapped to the appropriate <a href="../../../../jakarta/websocket/MessageHandler.html" title="interface in jakarta.websocket"><code>MessageHandler</code></a> until this method has completed.</li>
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../jakarta/websocket/Endpoint.html#onOpen(jakarta.websocket.Session,jakarta.websocket.EndpointConfig)">onOpen</a></code> in class <code><a href="../../../../jakarta/websocket/Endpoint.html" title="class in jakarta.websocket">Endpoint</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>session</code> - the session that has just been activated.</dd>
<dd><code>configuration</code> - the configuration used to configure this endpoint.</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/AnnotatedEndpoint.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>