Class ClientWebSocketContainer
java.lang.Object
org.springframework.integration.websocket.IntegrationWebSocketContainer
org.springframework.integration.websocket.ClientWebSocketContainer
- All Implemented Interfaces:
org.springframework.beans.factory.DisposableBean,org.springframework.context.Lifecycle,org.springframework.context.Phased,org.springframework.context.SmartLifecycle
public final class ClientWebSocketContainer extends IntegrationWebSocketContainer implements org.springframework.context.SmartLifecycle
The
IntegrationWebSocketContainer implementation for the client
Web-Socket connection.
Represent the composition over an internal ConnectionManagerSupport
implementation.
Accepts the clientSession WebSocketSession on
ConnectionManagerSupport.openConnection()
event, which can be accessed from this container using getSession(String).
- Since:
- 4.1
-
Field Summary
Fields inherited from class org.springframework.integration.websocket.IntegrationWebSocketContainer
DEFAULT_SEND_BUFFER_SIZE, DEFAULT_SEND_TIME_LIMIT, logger, sessions, webSocketHandler -
Constructor Summary
Constructors Constructor Description ClientWebSocketContainer(org.springframework.web.socket.client.WebSocketClient client, java.lang.String uriTemplate, java.lang.Object... uriVariables) -
Method Summary
Modifier and Type Method Description intgetPhase()org.springframework.web.socket.WebSocketSessiongetSession(java.lang.String sessionId)Return theclientSessionWebSocketSession.booleanisAutoStartup()booleanisConnected()Returntrueif theclientSessionis opened.booleanisRunning()voidsetAutoStartup(boolean autoStartup)voidsetConnectionTimeout(int connectionTimeout)Set the connection timeout in seconds; default: 10.voidsetHeaders(org.springframework.http.HttpHeaders headers)voidsetHeadersMap(java.util.Map<java.lang.String,java.lang.String> headers)voidsetOrigin(java.lang.String origin)voidsetPhase(int phase)voidstart()voidstop()voidstop(java.lang.Runnable callback)Methods inherited from class org.springframework.integration.websocket.IntegrationWebSocketContainer
addSupportedProtocols, closeSession, destroy, getSessions, getSubProtocols, setMessageListener, setSendBufferSizeLimit, setSendTimeLimit, setSupportedProtocols
-
Constructor Details
-
ClientWebSocketContainer
public ClientWebSocketContainer(org.springframework.web.socket.client.WebSocketClient client, java.lang.String uriTemplate, java.lang.Object... uriVariables)
-
-
Method Details
-
setOrigin
public void setOrigin(java.lang.String origin) -
setHeadersMap
public void setHeadersMap(java.util.Map<java.lang.String,java.lang.String> headers) -
setHeaders
public void setHeaders(org.springframework.http.HttpHeaders headers) -
setConnectionTimeout
public void setConnectionTimeout(int connectionTimeout)Set the connection timeout in seconds; default: 10.- Parameters:
connectionTimeout- the timeout in seconds.- Since:
- 4.2
-
getSession
public org.springframework.web.socket.WebSocketSession getSession(java.lang.String sessionId)Return theclientSessionWebSocketSession. Independently of provided argument, this method always returns only the establishedclientSession- Overrides:
getSessionin classIntegrationWebSocketContainer- Parameters:
sessionId- thesessionId. Can benull.- Returns:
- the
clientSession, if established.
-
setAutoStartup
public void setAutoStartup(boolean autoStartup) -
setPhase
public void setPhase(int phase) -
isConnected
public boolean isConnected()Returntrueif theclientSessionis opened.- Returns:
- the
WebSocketSession.isOpen()state. - Since:
- 4.2.6
-
isAutoStartup
public boolean isAutoStartup()- Specified by:
isAutoStartupin interfaceorg.springframework.context.SmartLifecycle
-
getPhase
public int getPhase()- Specified by:
getPhasein interfaceorg.springframework.context.Phased- Specified by:
getPhasein interfaceorg.springframework.context.SmartLifecycle
-
isRunning
public boolean isRunning()- Specified by:
isRunningin interfaceorg.springframework.context.Lifecycle
-
start
public void start()- Specified by:
startin interfaceorg.springframework.context.Lifecycle
-
stop
public void stop()- Specified by:
stopin interfaceorg.springframework.context.Lifecycle
-
stop
public void stop(java.lang.Runnable callback)- Specified by:
stopin interfaceorg.springframework.context.SmartLifecycle
-