@Deprecated public interface WebSocketConnection
This class represents the WebSocket connection established between the client and server. It provides methods which can be used by an application to manipulate the connection.
Modifier and Type | Method and Description |
---|---|
void |
close(int code)
Deprecated.
Initiating closing handshake with specified status code.
|
void |
close(int code,
String reason)
Deprecated.
Initiating closing handshake with specified status code and reason string.
|
String |
getRemoteAddress()
Deprecated.
Returns the Internet Protocol (IP) address of the client
or last proxy that sent the request.
|
int |
getRemotePort()
Deprecated.
Returns the Internet Protocol (IP) source port of the client
or last proxy that sent the request.
|
String |
getRemoteUser()
Deprecated.
Returns the login of the user making websocket handshake request if the
user has been authenticated, or
null if the user
has not been authenticated. |
String |
getRequestURI()
Deprecated.
Returns the part of websocket handshake request's URL from the protocol
name up to the query string.
|
Principal |
getUserPrincipal()
Deprecated.
Returns a
java.security.Principal object containing the name
of the authenticated user making websocket handshake request, or null
if the user has not been authenticated. |
WebSocketContext |
getWebSocketContext()
Deprecated.
Returns the
WebSocketContext instance associated with
this WebSocket connection. |
boolean |
isOpen()
Deprecated.
Returns the open state of the WebSocket connection.
|
boolean |
isSecure()
Deprecated.
Returns a boolean indicating whether this request was made using a
secure channel.
|
void |
send(byte[] message)
Deprecated.
Send binary data to client.
|
void |
send(String message)
Deprecated.
Send "UTF-8" encoded text data to client.
|
void |
sendPing(byte[] message)
Deprecated.
Send a ping frame with the specified data (if any).
|
void |
sendPong(byte[] message)
Deprecated.
Send a pong frame with the specified data (if any).
|
void |
stream(boolean last,
byte[] fragment,
int off,
int length)
Deprecated.
Send a fragment of a complete message.
|
void |
stream(boolean last,
String fragment)
Deprecated.
Send a fragment of a complete message.
|
void send(String message) throws IOException, IllegalStateException
message
- "UTF-8" encoded text data.IOException
- if error occurs when writing data to the WebSocket.IllegalStateException
- if connection is closed.void send(byte[] message) throws IOException, IllegalStateException
message
- binary data.IOException
- if error occurs when writing data to the WebSocket.IllegalStateException
- if connection is closed.void sendPing(byte[] message) throws IOException, IllegalStateException
message
- optional data.IOException
- if error occurs when writing data to the WebSocket.IllegalStateException
- if connection is closed.void sendPong(byte[] message) throws IOException, IllegalStateException
message
- optional data.IOException
- if error occurs when writing data to the WebSocket.IllegalStateException
- if connection is closed.void stream(boolean last, String fragment) throws IOException, IllegalStateException
last
- boolean indicating if this message fragment is the last.fragment
- the textual fragment to send.IOException
- if error occurs when sending fragment to the WebSocket.IllegalStateException
- if connection is closed.void stream(boolean last, byte[] fragment, int off, int length) throws IOException, IllegalStateException
last
- boolean indicating if this message fragment is the last.fragment
- the binary fragment to send.off
- the offset within the fragment to send.length
- the number of bytes of the fragment to send.IOException
- if error occurs when sending the fragment to the WebSocket.IllegalStateException
- if connection is closed.void close(int code) throws IOException
code
- closing status code.IOException
- if error occurs when sending the closing message.ClosingMessage
void close(int code, String reason) throws IOException
code
- closing status code.reason
- string for closing.IOException
- if error occurs when sending the closing message.ClosingMessage
boolean isOpen()
boolean isSecure()
String getRemoteAddress()
String
containing the IP address of the client
that sent the request.int getRemotePort()
String getRemoteUser()
null
if the user
has not been authenticated.String
specifying the login of the user making
websocket handshake request, or null
if the user login is unknown.String getRequestURI()
javax.servlet.http.HttpServletRequest.getRequestURI()
method.String
containing the part of websocket handshake
request's URL from the protocol name up to the query string.Principal getUserPrincipal()
java.security.Principal
object containing the name
of the authenticated user making websocket handshake request, or null
if the user has not been authenticated.java.security.Principal
containing the name of the
authenticated user making websocket handshake request; or null
if the user has not been authenticated.WebSocketContext getWebSocketContext()
WebSocketContext
instance associated with
this WebSocket connection.