Class IntegrationWebSocketContainer

java.lang.Object

org.springframework.integration.websocket.IntegrationWebSocketContainer

All Implemented Interfaces:

DisposableBean

Direct Known Subclasses:

ClientWebSocketContainer, ServerWebSocketContainer

public abstract class IntegrationWebSocketContainer
extends Object
implements DisposableBean

The high-level 'connection factory pattern' contract over low-level Web-Socket configuration.

Provides the composition for the internal WebSocketHandler implementation, which is used with native Web-Socket containers.

Collects established WebSocketSessions, which can be accessed using getSession(String).

Can accept the WebSocketListener to delegate WebSocketSession events from the internal IntegrationWebSocketContainer.IntegrationWebSocketHandler.

Supported sub-protocols can be configured, but SubProtocolCapable.getSubProtocols() have a precedent.

Since:

4.1

Author:

Artem Bilan, Gary Russell, Julian Koch

See Also:

• WebSocketInboundChannelAdapter
• WebSocketOutboundMessageHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_SEND_BUFFER_SIZE
static final int	DEFAULT_SEND_TIME_LIMIT
protected final Lock	lock
protected final Log	logger
protected final Map<String, WebSocketSession>	sessions

Constructor Summary

Constructors

Constructor	Description
IntegrationWebSocketContainer()

Method Summary

Modifier and Type	Method	Description
void	addSupportedProtocols(String... protocols)
void	closeSession(WebSocketSession session, CloseStatus closeStatus)
void	destroy()
WebSocketSession	getSession(@Nullable String sessionId)
Map<String, WebSocketSession>	getSessions()
List<String>	getSubProtocols()
WebSocketHandler	getWebSocketHandler()
void	setMessageListener(WebSocketListener messageListener)
void	setSendBufferOverflowStrategy(@Nullable ConcurrentWebSocketSessionDecorator.OverflowStrategy overflowStrategy)	Set the send buffer overflow strategy.
void	setSendBufferSizeLimit(int sendBufferSizeLimit)
void	setSendTimeLimit(int sendTimeLimit)
void	setSupportedProtocols(String... protocols)
protected void	setWebSocketHandler(WebSocketHandler handler)	Replace the default WebSocketHandler with the one provided here, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_SEND_TIME_LIMIT

public static final int DEFAULT_SEND_TIME_LIMIT

See Also:

• Constant Field Values

DEFAULT_SEND_BUFFER_SIZE

public static final int DEFAULT_SEND_BUFFER_SIZE

See Also:

• Constant Field Values

logger

protected final Log logger

lock

protected final Lock lock

sessions

protected final Map<String, WebSocketSession> sessions

Constructor Details

IntegrationWebSocketContainer

public IntegrationWebSocketContainer()

Method Details

setSendTimeLimit

public void setSendTimeLimit(int sendTimeLimit)

setSendBufferSizeLimit

public void setSendBufferSizeLimit(int sendBufferSizeLimit)

setSendBufferOverflowStrategy

public void setSendBufferOverflowStrategy(@Nullable ConcurrentWebSocketSessionDecorator.OverflowStrategy overflowStrategy)

Set the send buffer overflow strategy.

Concurrently generated outbound messages are buffered if sending is slow. This strategy determines the behavior when the buffer has reached the limit configured with setSendBufferSizeLimit(int).

Parameters:

overflowStrategy - The ConcurrentWebSocketSessionDecorator.OverflowStrategy to use.

Since:

5.5.19

See Also:

• ConcurrentWebSocketSessionDecorator

setMessageListener

public void setMessageListener(WebSocketListener messageListener)

setSupportedProtocols

public void setSupportedProtocols(String... protocols)

addSupportedProtocols

public void addSupportedProtocols(String... protocols)

setWebSocketHandler

protected void setWebSocketHandler(WebSocketHandler handler)

Replace the default WebSocketHandler with the one provided here, e.g. via decoration factories.

Parameters:

handler - the actual WebSocketHandler to replace.

Since:

5.5.18

getWebSocketHandler

public WebSocketHandler getWebSocketHandler()

getSubProtocols

public List<String> getSubProtocols()

getSessions

public Map<String, WebSocketSession> getSessions()

getSession

public WebSocketSession getSession(@Nullable String sessionId)

closeSession

public void closeSession(WebSocketSession session,
 CloseStatus closeStatus)
                  throws Exception

Throws:

Exception

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean