public class StompWebSocketHandler extends TextWebSocketHandlerAdapter implements MessageHandler
| Modifier and Type | Field and Description |
|---|---|
static String |
CONNECTED_USER_HEADER
The name of the header set on the CONNECTED frame indicating the name of the user
connected authenticated on the WebSocket session.
|
static String |
QUEUE_SUFFIX_HEADER
A suffix unique to the current session that a client can use to append to
a destination to make it unique.
|
| Constructor and Description |
|---|
StompWebSocketHandler(MessageChannel dispatchChannel) |
| Modifier and Type | Method and Description |
|---|---|
void |
afterConnectionClosed(WebSocketSession session,
CloseStatus status)
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.
|
StompMessageConverter |
getStompMessageConverter() |
MutableUserQueueSuffixResolver |
getUserQueueSuffixResolver() |
protected void |
handleConnect(WebSocketSession session,
Message<?> message) |
void |
handleMessage(Message<?> message)
Handle STOMP messages going back out to WebSocket clients.
|
protected void |
handleTextMessage(WebSocketSession session,
TextMessage textMessage)
Handle incoming WebSocket messages from clients.
|
protected void |
sendErrorMessage(WebSocketSession session,
Throwable error) |
void |
setUserQueueSuffixResolver(MutableUserQueueSuffixResolver resolver)
Configure a resolver to use to maintain queue suffixes for user
|
handleBinaryMessagehandleMessage, handleTransportError, supportsPartialMessagespublic static final String CONNECTED_USER_HEADER
public static final String QUEUE_SUFFIX_HEADER
org.springframework.messaging.simp.handler.UserDestinationMessageHandler},
Constant Field Valuespublic StompWebSocketHandler(MessageChannel dispatchChannel)
dispatchChannel - the channel to send client STOMP/WebSocket messages topublic void setUserQueueSuffixResolver(MutableUserQueueSuffixResolver resolver)
org.springframework.messaging.simp.handler.UserDestinationMessageHandler}public MutableUserQueueSuffixResolver getUserQueueSuffixResolver()
public StompMessageConverter getStompMessageConverter()
public void afterConnectionEstablished(WebSocketSession session) throws Exception
WebSocketHandlerafterConnectionEstablished in interface WebSocketHandlerafterConnectionEstablished in class WebSocketHandlerAdapterException - this method can handle or propagate exceptions; see class-level
Javadoc for details.protected void handleTextMessage(WebSocketSession session, TextMessage textMessage)
handleTextMessage in class WebSocketHandlerAdapterprotected void handleConnect(WebSocketSession session, Message<?> message) throws IOException
IOExceptionprotected void sendErrorMessage(WebSocketSession session, Throwable error)
public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception
WebSocketHandlerafterConnectionClosed in interface WebSocketHandlerafterConnectionClosed in class WebSocketHandlerAdapterException - this method can handle or propagate exceptions; see class-level
Javadoc for details.public void handleMessage(Message<?> message)
handleMessage in interface MessageHandlermessage - the message to be handled
reply related to the handling of the message