public interface Session extends Closeable
Once the session is closed, it is no longer valid for use by applications. Calling any of its methods (with the
exception of the close() methods) once the session has been closed will result in an
IllegalStateException
being thrown. Developers should retrieve any information from the session
during the Endpoint.onClose(javax.websocket.Session, javax.websocket.CloseReason)
method. Following the convention of Closeable
calling the Session
close() methods after the Session has been closed has no effect.
Session objects may be called by multiple threads. Implementations must ensure the integrity of the mutable properties of the session under such circumstances.
Modifier and Type | Method and Description |
---|---|
<T> void |
addMessageHandler(Class<T> clazz,
MessageHandler.Partial<T> handler)
Register to handle to incoming messages in this conversation.
|
<T> void |
addMessageHandler(Class<T> clazz,
MessageHandler.Whole<T> handler)
Register to handle to incoming messages in this conversation.
|
void |
addMessageHandler(MessageHandler handler)
Register to handle to incoming messages in this conversation.
|
void |
close()
Close the current conversation with a normal status code and no reason phrase.
|
void |
close(CloseReason closeReason)
Close the current conversation, giving a reason for the closure.
|
RemoteEndpoint.Async |
getAsyncRemote()
Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send
messages asynchronously to the peer.
|
RemoteEndpoint.Basic |
getBasicRemote()
Return a reference a RemoteEndpoint object representing the peer of this conversation that is able to send
messages synchronously to the peer.
|
WebSocketContainer |
getContainer()
Return the container that this session is part of.
|
String |
getId()
Returns a string containing the unique identifier assigned to this session.
|
int |
getMaxBinaryMessageBufferSize()
The maximum length of incoming binary messages that this Session can buffer.
|
long |
getMaxIdleTimeout()
Return the number of milliseconds before this conversation may be closed by the container if it is inactive, i.e.
|
int |
getMaxTextMessageBufferSize()
The maximum length of incoming text messages that this Session can buffer.
|
Set<MessageHandler> |
getMessageHandlers()
Return an unmodifiable copy of the set of MessageHandlers for this Session.
|
List<Extension> |
getNegotiatedExtensions()
Return the list of extensions currently in use for this conversation.
|
String |
getNegotiatedSubprotocol()
Return the sub protocol agreed during the websocket handshake for this conversation.
|
Set<Session> |
getOpenSessions()
Return a copy of the Set of all the open web socket sessions that represent connections to the same endpoint to
which this session represents a connection.
|
Map<String,String> |
getPathParameters()
Return a map of the path parameter names and values used associated with the request this session was opened
under.
|
String |
getProtocolVersion()
Returns the version of the websocket protocol currently being used.
|
String |
getQueryString()
Return the query string associated with the request this session was opened under.
|
Map<String,List<String>> |
getRequestParameterMap()
Return the request parameters associated with the request this session was opened under.
|
URI |
getRequestURI()
Return the URI under which this session was opened, including the query string if there is one.
|
Principal |
getUserPrincipal()
Return the authenticated user for this Session or
null if no user is authenticated for this session. |
Map<String,Object> |
getUserProperties()
While the session is open, this method returns a Map that the developer may use to store application specific
information relating to this session instance.
|
boolean |
isOpen()
Return true if and only if the underlying socket is open.
|
boolean |
isSecure()
Return true if and only if the underlying socket is using a secure transport.
|
void |
removeMessageHandler(MessageHandler handler)
Remove the given MessageHandler from the set belonging to this session.
|
void |
setMaxBinaryMessageBufferSize(int length)
Sets the maximum length of incoming binary messages that this Session can buffer.
|
void |
setMaxIdleTimeout(long milliseconds)
Set the non-zero number of milliseconds before this session will be closed by the container if it is inactive, ie
no messages are either sent or received.
|
void |
setMaxTextMessageBufferSize(int length)
Sets the maximum length of incoming text messages that this Session can buffer.
|
WebSocketContainer getContainer()
void addMessageHandler(MessageHandler handler) throws IllegalStateException
MessageHandler.Whole
and MessageHandler.Partial
.
Adding more than one of any one type will result in a runtime exception.
This method is not safe to use unless you are providing an anonymous class derived directly from
MessageHandler.Whole
or MessageHandler.Partial
. In all other
cases (Lambda Expressions, more complex inheritance or generic type arrangements), one of the following methods
have to be used: addMessageHandler(Class, javax.websocket.MessageHandler.Whole)
or
addMessageHandler(Class, javax.websocket.MessageHandler.Partial)
.
handler
- the MessageHandler to be added.IllegalStateException
- if there is already a MessageHandler registered for the same native websocket
message type as this handler.<T> void addMessageHandler(Class<T> clazz, MessageHandler.Whole<T> handler)
MessageHandler.Whole
and MessageHandler.Partial
.
Adding more than one of any one type will result in a runtime exception.T
- type of message that the given handler is intended for.clazz
- type of the message processed by message handler to be registered.handler
- whole message handler to be added.IllegalStateException
- if there is already a MessageHandler registered for the same native websocket
message type as this handler.<T> void addMessageHandler(Class<T> clazz, MessageHandler.Partial<T> handler)
MessageHandler.Whole
and MessageHandler.Partial
.
Adding more than one of any one type will result in a runtime exception.T
- type of message that the given handler is intended for.clazz
- type of the message processed by message handler to be registered.handler
- partial message handler to be added.IllegalStateException
- if there is already a MessageHandler registered for the same native websocket
message type as this handler.Set<MessageHandler> getMessageHandlers()
void removeMessageHandler(MessageHandler handler)
handler
- the handler to be removed.String getProtocolVersion()
String getNegotiatedSubprotocol()
List<Extension> getNegotiatedExtensions()
boolean isSecure()
boolean isOpen()
long getMaxIdleTimeout()
void setMaxIdleTimeout(long milliseconds)
milliseconds
- the number of milliseconds.void setMaxBinaryMessageBufferSize(int length)
length
- the maximum length.int getMaxBinaryMessageBufferSize()
CloseReason.CloseCodes.TOO_BIG
.void setMaxTextMessageBufferSize(int length)
length
- the maximum length.int getMaxTextMessageBufferSize()
CloseReason.CloseCodes.TOO_BIG
.RemoteEndpoint.Async getAsyncRemote()
RemoteEndpoint.Basic getBasicRemote()
String getId()
void close() throws IOException
close
in interface AutoCloseable
close
in interface Closeable
IOException
- if there was a connection error closing the connection.void close(CloseReason closeReason) throws IOException
CloseReason.CloseCodes.NO_STATUS_CODE
.closeReason
- the reason for the closure.IOException
- if there was a connection error closing the connectionURI getRequestURI()
Map<String,List<String>> getRequestParameterMap()
String getQueryString()
Map<String,String> getPathParameters()
Map<String,Object> getUserProperties()
Principal getUserPrincipal()
null
if no user is authenticated for this session.Set<Session> getOpenSessions()
Copyright © 2019 Eclipse Foundation
Use is subject to license terms.