public class SubProtocolWebSocketHandler extends java.lang.Object implements WebSocketHandler, SubProtocolCapable, MessageHandler, SmartLifecycle
WebSocketHandler
that delegates incoming WebSocket
messages to a SubProtocolHandler
along with a MessageChannel
to
which the sub-protocol handler can send messages from WebSocket clients to
the application.
Also an implementation of MessageHandler
that finds the WebSocket
session associated with the Message
and passes it, along with the message,
to the sub-protocol handler to send messages from the application back to the
client.
Modifier and Type | Class and Description |
---|---|
private class |
SubProtocolWebSocketHandler.Stats |
private static class |
SubProtocolWebSocketHandler.WebSocketSessionHolder |
Modifier and Type | Field and Description |
---|---|
private MessageChannel |
clientInboundChannel |
private SubscribableChannel |
clientOutboundChannel |
private SubProtocolHandler |
defaultProtocolHandler |
private long |
lastSessionCheckTime |
private java.lang.Object |
lifecycleMonitor |
private Log |
logger |
private java.util.Map<java.lang.String,SubProtocolHandler> |
protocolHandlerLookup |
private java.util.List<SubProtocolHandler> |
protocolHandlers |
private boolean |
running |
private int |
sendBufferSizeLimit |
private int |
sendTimeLimit |
private java.util.concurrent.locks.ReentrantLock |
sessionCheckLock |
private java.util.Map<java.lang.String,SubProtocolWebSocketHandler.WebSocketSessionHolder> |
sessions |
private SubProtocolWebSocketHandler.Stats |
stats |
private static int |
TIME_TO_FIRST_MESSAGE
Sessions connected to this handler use a sub-protocol.
|
Constructor and Description |
---|
SubProtocolWebSocketHandler(MessageChannel clientInboundChannel,
SubscribableChannel clientOutboundChannel) |
Modifier and Type | Method and Description |
---|---|
void |
addProtocolHandler(SubProtocolHandler handler)
Register a sub-protocol handler.
|
void |
afterConnectionClosed(WebSocketSession session,
CloseStatus closeStatus)
Invoked after the WebSocket connection has been closed by either side, or after a
transport error has occurred.
|
void |
afterConnectionEstablished(WebSocketSession session)
Invoked after WebSocket negotiation has succeeded and the WebSocket connection is
opened and ready for use.
|
private void |
checkSessions()
When a session is connected through a higher-level protocol it has a chance
to use heartbeat management to shut down sessions that are too slow to send
or receive messages.
|
private void |
clearSession(WebSocketSession session,
CloseStatus closeStatus) |
protected SubProtocolHandler |
findProtocolHandler(WebSocketSession session) |
SubProtocolHandler |
getDefaultProtocolHandler() |
int |
getPhase()
Return the phase value of this object.
|
java.util.Map<java.lang.String,SubProtocolHandler> |
getProtocolHandlerMap()
Return the sub-protocols keyed by protocol name.
|
java.util.List<SubProtocolHandler> |
getProtocolHandlers() |
int |
getSendBufferSizeLimit() |
int |
getSendTimeLimit() |
java.lang.String |
getStatsInfo()
Return a String describing internal state and counters.
|
java.util.List<java.lang.String> |
getSubProtocols()
Return all supported protocols.
|
void |
handleMessage(Message<?> message)
Handle an outbound Spring Message to a WebSocket client.
|
void |
handleMessage(WebSocketSession session,
WebSocketMessage<?> message)
Handle an inbound message from a WebSocket client.
|
void |
handleTransportError(WebSocketSession session,
java.lang.Throwable exception)
Handle an error from the underlying WebSocket message transport.
|
boolean |
isAutoStartup()
Return whether this Lifecycle component should be started automatically
by the container when the ApplicationContext is refreshed.
|
boolean |
isRunning()
Check whether this component is currently running.
|
private java.lang.String |
resolveSessionId(Message<?> message) |
void |
setDefaultProtocolHandler(SubProtocolHandler defaultProtocolHandler)
Set the
SubProtocolHandler to use when the client did not request a
sub-protocol. |
void |
setProtocolHandlers(java.util.List<SubProtocolHandler> protocolHandlers)
Configure one or more handlers to use depending on the sub-protocol requested by
the client in the WebSocket handshake request.
|
void |
setSendBufferSizeLimit(int sendBufferSizeLimit) |
void |
setSendTimeLimit(int sendTimeLimit) |
void |
start()
Start this component.
|
void |
stop()
Stop this component, typically in a synchronous fashion, such that
the component is fully stopped upon return of this method.
|
void |
stop(java.lang.Runnable callback)
Indicates that a Lifecycle component must stop if it is currently running.
|
boolean |
supportsPartialMessages()
Whether the WebSocketHandler handles partial messages.
|
java.lang.String |
toString() |
private static final int TIME_TO_FIRST_MESSAGE
checkSessions()
,
Constant Field Valuesprivate final Log logger
private final MessageChannel clientInboundChannel
private final SubscribableChannel clientOutboundChannel
private final java.util.Map<java.lang.String,SubProtocolHandler> protocolHandlerLookup
private final java.util.List<SubProtocolHandler> protocolHandlers
private SubProtocolHandler defaultProtocolHandler
private final java.util.Map<java.lang.String,SubProtocolWebSocketHandler.WebSocketSessionHolder> sessions
private int sendTimeLimit
private int sendBufferSizeLimit
private volatile long lastSessionCheckTime
private final java.util.concurrent.locks.ReentrantLock sessionCheckLock
private final SubProtocolWebSocketHandler.Stats stats
private final java.lang.Object lifecycleMonitor
private volatile boolean running
public SubProtocolWebSocketHandler(MessageChannel clientInboundChannel, SubscribableChannel clientOutboundChannel)
public void setProtocolHandlers(java.util.List<SubProtocolHandler> protocolHandlers)
protocolHandlers
- the sub-protocol handlers to usepublic java.util.List<SubProtocolHandler> getProtocolHandlers()
public void addProtocolHandler(SubProtocolHandler handler)
public java.util.Map<java.lang.String,SubProtocolHandler> getProtocolHandlerMap()
public void setDefaultProtocolHandler(SubProtocolHandler defaultProtocolHandler)
SubProtocolHandler
to use when the client did not request a
sub-protocol.defaultProtocolHandler
- the default handlerpublic SubProtocolHandler getDefaultProtocolHandler()
public java.util.List<java.lang.String> getSubProtocols()
getSubProtocols
in interface SubProtocolCapable
public void setSendTimeLimit(int sendTimeLimit)
public int getSendTimeLimit()
public void setSendBufferSizeLimit(int sendBufferSizeLimit)
public int getSendBufferSizeLimit()
public boolean isAutoStartup()
SmartLifecycle
isAutoStartup
in interface SmartLifecycle
public int getPhase()
Phased
public final boolean isRunning()
Lifecycle
In the case of a container, this will return true
only if all components that apply are currently running.
public java.lang.String getStatsInfo()
public final void start()
Lifecycle
In the case of a container, this will propagate the start signal to all components that apply.
public final void stop()
Lifecycle
SmartLifecycle
and its stop(Runnable)
variant in cases where asynchronous stop behavior is necessary.
Should not throw an exception if the component isn't started yet.
In the case of a container, this will propagate the stop signal to all components that apply.
stop
in interface Lifecycle
SmartLifecycle.stop(Runnable)
public final void stop(java.lang.Runnable callback)
SmartLifecycle
The provided callback is used by the LifecycleProcessor
to support an
ordered, and potentially concurrent, shutdown of all components having a
common shutdown order value. The callback must be executed after
the SmartLifecycle component does indeed stop.
The LifecycleProcessor
will call only this variant of the
stop
method; i.e. Lifecycle.stop()
will not be called for
SmartLifecycle
implementations unless explicitly delegated to within
this method.
stop
in interface SmartLifecycle
public void afterConnectionEstablished(WebSocketSession session) throws java.lang.Exception
WebSocketHandler
afterConnectionEstablished
in interface WebSocketHandler
java.lang.Exception
- this method can handle or propagate exceptions; see class-level
Javadoc for details.protected final SubProtocolHandler findProtocolHandler(WebSocketSession session)
public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws java.lang.Exception
handleMessage
in interface WebSocketHandler
java.lang.Exception
- this method can handle or propagate exceptions; see class-level
Javadoc for details.public void handleMessage(Message<?> message) throws MessagingException
handleMessage
in interface MessageHandler
message
- the message to be handledMessagingException
private java.lang.String resolveSessionId(Message<?> message)
private void checkSessions() throws java.io.IOException
java.io.IOException
public void handleTransportError(WebSocketSession session, java.lang.Throwable exception) throws java.lang.Exception
WebSocketHandler
handleTransportError
in interface WebSocketHandler
java.lang.Exception
- this method can handle or propagate exceptions; see class-level
Javadoc for details.public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws java.lang.Exception
WebSocketHandler
afterConnectionClosed
in interface WebSocketHandler
java.lang.Exception
- this method can handle or propagate exceptions; see class-level
Javadoc for details.private void clearSession(WebSocketSession session, CloseStatus closeStatus) throws java.lang.Exception
java.lang.Exception
public boolean supportsPartialMessages()
WebSocketHandler
true
and the underlying WebSocket server supports partial messages,
then a large WebSocket message, or one of an unknown size may be split and
maybe received over multiple calls to
WebSocketHandler.handleMessage(WebSocketSession, WebSocketMessage)
. The flag
WebSocketMessage.isLast()
indicates if
the message is partial and whether it is the last part.supportsPartialMessages
in interface WebSocketHandler
public java.lang.String toString()
toString
in class java.lang.Object