public class WebSocketConnectionManager extends ConnectionManagerSupport
WebSocketClient
, and a
WebSocketHandler
, connects to a WebSocket server through ConnectionManagerSupport.start()
and
ConnectionManagerSupport.stop()
methods. If ConnectionManagerSupport.setAutoStartup(boolean)
is set to true
this will be done automatically when the Spring ApplicationContext is refreshed.logger
Constructor and Description |
---|
WebSocketConnectionManager(WebSocketClient client,
WebSocketHandler webSocketHandler,
String uriTemplate,
Object... uriVariables) |
Modifier and Type | Method and Description |
---|---|
protected void |
closeConnection() |
protected WebSocketHandler |
decorateWebSocketHandler(WebSocketHandler handler)
Decorate the WebSocketHandler provided to the class constructor.
|
HttpHeaders |
getHeaders()
Return the default headers for the WebSocket handshake request.
|
String |
getOrigin() |
List<String> |
getSubProtocols()
Return the configured sub-protocols to use.
|
protected boolean |
isConnected() |
protected void |
openConnection() |
void |
setHeaders(HttpHeaders headers)
Provide default headers to add to the WebSocket handshake request.
|
void |
setOrigin(String origin)
Set the origin to use.
|
void |
setSubProtocols(List<String> protocols)
Set the sub-protocols to use.
|
void |
startInternal() |
void |
stopInternal() |
getPhase, getUri, isAutoStartup, isRunning, setAutoStartup, setPhase, start, stop, stop
public WebSocketConnectionManager(WebSocketClient client, WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVariables)
protected WebSocketHandler decorateWebSocketHandler(WebSocketHandler handler)
By default LoggingWebSocketHandlerDecorator
is added.
public void setSubProtocols(List<String> protocols)
Sec-WebSocket-Protocol
header. The
resulting WebSocket session will contain the protocol accepted by the server, if
any.public void setOrigin(String origin)
public String getOrigin()
public void setHeaders(HttpHeaders headers)
public HttpHeaders getHeaders()
public void startInternal()
startInternal
in class ConnectionManagerSupport
public void stopInternal() throws Exception
stopInternal
in class ConnectionManagerSupport
Exception
protected void openConnection()
openConnection
in class ConnectionManagerSupport
protected void closeConnection() throws Exception
closeConnection
in class ConnectionManagerSupport
Exception
protected boolean isConnected()
isConnected
in class ConnectionManagerSupport