org.springframework.integration.websocket.support

Class PassThruSubProtocolHandler

java.lang.Object

org.springframework.integration.websocket.support.PassThruSubProtocolHandler

All Implemented Interfaces:

SubProtocolHandler

public class PassThruSubProtocolHandler
extends Object
implements SubProtocolHandler

The simple 'pass thru' SubProtocolHandler, when there is no interests in the WebSocket sub-protocols. This class just convert Message to the WebSocketMessage on 'send' part and vise versa - on 'receive' part.

Since:

4.1

Author:

Artem Bilan

Constructor Summary

Constructors

Constructor and Description
PassThruSubProtocolHandler()

Method Summary

Modifier and Type	Method and Description
void	afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)
void	afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)
List<String>	getSupportedProtocols()
void	handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> webSocketMessage, MessageChannel outputChannel)
void	handleMessageToClient(WebSocketSession session, Message<?> message)
String	resolveSessionId(Message<?> message)
void	setSupportedProtocols(String... supportedProtocols)

Methods inherited from class java.lang.Object

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

Constructor Detail

PassThruSubProtocolHandler

public PassThruSubProtocolHandler()

Method Detail

setSupportedProtocols

public void setSupportedProtocols(String... supportedProtocols)

getSupportedProtocols

public List<String> getSupportedProtocols()

Specified by:

getSupportedProtocols in interface SubProtocolHandler

handleMessageFromClient

public void handleMessageFromClient(WebSocketSession session,
                                    WebSocketMessage<?> webSocketMessage,
                                    MessageChannel outputChannel)

Specified by:

handleMessageFromClient in interface SubProtocolHandler

handleMessageToClient

public void handleMessageToClient(WebSocketSession session,
                                  Message<?> message)
                           throws Exception

Specified by:

handleMessageToClient in interface SubProtocolHandler

Throws:

Exception

resolveSessionId

public String resolveSessionId(Message<?> message)

Specified by:

resolveSessionId in interface SubProtocolHandler

afterSessionStarted

public void afterSessionStarted(WebSocketSession session,
                                MessageChannel outputChannel)

Specified by:

afterSessionStarted in interface SubProtocolHandler

afterSessionEnded

public void afterSessionEnded(WebSocketSession session,
                              CloseStatus closeStatus,
                              MessageChannel outputChannel)

Specified by:

afterSessionEnded in interface SubProtocolHandler