Package org.springframework.integration.websocket

Interface WebSocketListener

All Superinterfaces:

SubProtocolCapable

All Known Implementing Classes:

WebSocketInboundChannelAdapter

public interface WebSocketListener
extends SubProtocolCapable

A contract for handling incoming WebSocketMessages messages as part of a higher level protocol, referred to as "sub-protocol" in the WebSocket RFC specification.

Implementations of this interface can be configured on a IntegrationWebSocketContainer which delegates messages and WebSocketSession events to this implementation.

Since:

4.1

Author:

Andy Wilkinson, Artem Bilan

See Also:

WebSocketInboundChannelAdapter

Method Summary

Modifier and Type	Method	Description
void	afterSessionEnded(WebSocketSession session, CloseStatus closeStatus)	Invoked after a WebSocketSession has ended.
void	afterSessionStarted(WebSocketSession session)	Invoked after a WebSocketSession has started.
void	onMessage(WebSocketSession session, WebSocketMessage<?> message)	Handle the received WebSocketMessage.

Methods inherited from interface org.springframework.web.socket.SubProtocolCapable

getSubProtocols

Method Details

onMessage

void onMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception

Handle the received WebSocketMessage.

Parameters:

session - the WebSocket session

message - the WebSocket message

Throws:

Exception - the 'onMessage' Exception

afterSessionStarted

void afterSessionStarted(WebSocketSession session) throws Exception

Invoked after a WebSocketSession has started.

Parameters:

session - the WebSocket session

Throws:

Exception - the 'afterSessionStarted' Exception

afterSessionEnded

void afterSessionEnded(WebSocketSession session, CloseStatus closeStatus) throws Exception

Invoked after a WebSocketSession has ended.

Parameters:

session - the WebSocket session

closeStatus - the reason why the session was closed

Throws:

Exception - the 'afterSessionEnded' Exception