xref: /unit/src/java/javax/websocket/Endpoint.java (revision 1157:7ae152bda303)
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements.  See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License.  You may obtain a copy of the License at
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 package javax.websocket;
18 
19 public abstract class Endpoint {
20 
21     /**
22      * Event that is triggered when a new session starts.
23      *
24      * @param session   The new session.
25      * @param config    The configuration with which the Endpoint was
26      *                  configured.
27      */
onOpen(Session session, EndpointConfig config)28     public abstract void onOpen(Session session, EndpointConfig config);
29 
30     /**
31      * Event that is triggered when a session has closed.
32      *
33      * @param session       The session
34      * @param closeReason   Why the session was closed
35      */
onClose(Session session, CloseReason closeReason)36     public void onClose(Session session, CloseReason closeReason) {
37         // NO-OP by default
38     }
39 
40     /**
41      * Event that is triggered when a protocol error occurs.
42      *
43      * @param session   The session.
44      * @param throwable The exception.
45      */
onError(Session session, Throwable throwable)46     public void onError(Session session, Throwable throwable) {
47         // NO-OP by default
48     }
49 }
50