| /* |
| * 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 { |
| |
| /** |
| * Returns the container that created this session. |
| */ |
| WebSocketContainer getContainer(); |
| |
| void addMessageHandler(MessageHandler listener) |
| 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 in milliseconds. Zero or negative |
| * values indicate an infinite timeout. |
| */ |
| long getMaxIdleTimeout(); |
| |
| /** |
| * Set the idle timeout for this session in milliseconds. Zero or negative |
| * values indicate an infinite timeout. |
| */ |
| void setMaxIdleTimeout(long seconds); |
| |
| /** |
| * Set the current maximum buffer size (in bytes) for binary messages. |
| */ |
| void setMaxBinaryMessageBufferSize(int max); |
| |
| /** |
| * Get the current maximum buffer size (in bytes) for binary messages. |
| */ |
| int getMaxBinaryMessageBufferSize(); |
| |
| /** |
| * Set the current maximum buffer size (in characters) for text messages. |
| */ |
| void setMaxTextMessageBufferSize(int max); |
| |
| /** |
| * Get the current maximum buffer size (in characters) for text messages. |
| */ |
| 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. |
| */ |
| 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 |
| */ |
| @Override |
| void close() throws IOException; |
| |
| |
| /** |
| * Close the connection to the remote end point using the specified code |
| * and reason phrase. |
| * |
| * @throws IOException |
| */ |
| void close(CloseReason closeStatus) 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 currently open sessions for the local endpoint that |
| * this session is associated with. |
| */ |
| Set<Session> getOpenSessions(); |
| } |