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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javax.websocket;
import java.io.Closeable;
import java.io.IOException;
import java.net.URI;
import java.security.Principal;
import java.util.List;
import java.util.Map;
import java.util.Set;
public interface Session extends Closeable {
/**
* Get the container that created this session.
* @return the container that created this session.
*/
WebSocketContainer getContainer();
/**
* Registers a {@link MessageHandler} for incoming messages. Only one
* {@link MessageHandler} may be registered for each message type (text,
* binary, pong). The message type will be derived at runtime from the
* provided {@link MessageHandler} instance. It is not always possible to do
* this so it is better to use
* {@link #addMessageHandler(Class, javax.websocket.MessageHandler.Partial)}
* or
* {@link #addMessageHandler(Class, javax.websocket.MessageHandler.Whole)}.
*
* @param handler The message handler for a incoming message
*
* @throws IllegalStateException If a message handler has already been
* registered for the associated message type
*/
void addMessageHandler(MessageHandler handler) throws IllegalStateException;
Set<MessageHandler> getMessageHandlers();
void removeMessageHandler(MessageHandler listener);
String getProtocolVersion();
String getNegotiatedSubprotocol();
List<Extension> getNegotiatedExtensions();
boolean isSecure();
boolean isOpen();
/**
* Get the idle timeout for this session.
* @return The current idle timeout for this session in milliseconds. Zero
* or negative values indicate an infinite timeout.
*/
long getMaxIdleTimeout();
/**
* Set the idle timeout for this session.
* @param timeout The new idle timeout for this session in milliseconds.
* Zero or negative values indicate an infinite timeout.
*/
void setMaxIdleTimeout(long timeout);
/**
* Set the current maximum buffer size for binary messages.
* @param max The new maximum buffer size in bytes
*/
void setMaxBinaryMessageBufferSize(int max);
/**
* Get the current maximum buffer size for binary messages.
* @return The current maximum buffer size in bytes
*/
int getMaxBinaryMessageBufferSize();
/**
* Set the maximum buffer size for text messages.
* @param max The new maximum buffer size in characters.
*/
void setMaxTextMessageBufferSize(int max);
/**
* Get the maximum buffer size for text messages.
* @return The maximum buffer size in characters.
*/
int getMaxTextMessageBufferSize();
RemoteEndpoint.Async getAsyncRemote();
RemoteEndpoint.Basic getBasicRemote();
/**
* Provides a unique identifier for the session. This identifier should not
* be relied upon to be generated from a secure random source.
* @return A unique identifier for the session.
*/
String getId();
/**
* Close the connection to the remote end point using the code
* {@link javax.websocket.CloseReason.CloseCodes#NORMAL_CLOSURE} and an
* empty reason phrase.
*
* @throws IOException if an I/O error occurs while the WebSocket session is
* being closed.
*/
@Override
void close() throws IOException;
/**
* Close the connection to the remote end point using the specified code
* and reason phrase.
* @param closeReason The reason the WebSocket session is being closed.
*
* @throws IOException if an I/O error occurs while the WebSocket session is
* being closed.
*/
void close(CloseReason closeReason) throws IOException;
URI getRequestURI();
Map<String, List<String>> getRequestParameterMap();
String getQueryString();
Map<String,String> getPathParameters();
Map<String,Object> getUserProperties();
Principal getUserPrincipal();
/**
* Obtain the set of open sessions associated with the same local endpoint
* as this session.
*
* @return The set of currently open sessions for the local endpoint that
* this session is associated with.
*/
Set<Session> getOpenSessions();
/**
* Registers a {@link MessageHandler} for partial incoming messages. Only
* one {@link MessageHandler} may be registered for each message type (text
* or binary, pong messages are never presented as partial messages).
*
* @param <T> The type of message that the given handler is intended
* for
* @param clazz The Class that implements T
* @param handler The message handler for a incoming message
*
* @throws IllegalStateException If a message handler has already been
* registered for the associated message type
*
* @since WebSocket 1.1
*/
<T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler)
throws IllegalStateException;
/**
* Registers a {@link MessageHandler} for whole incoming messages. Only
* one {@link MessageHandler} may be registered for each message type (text,
* binary, pong).
*
* @param <T> The type of message that the given handler is intended
* for
* @param clazz The Class that implements T
* @param handler The message handler for a incoming message
*
* @throws IllegalStateException If a message handler has already been
* registered for the associated message type
*
* @since WebSocket 1.1
*/
<T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler)
throws IllegalStateException;
}
|
