Class ExceptionWebSocketHandlerDecorator
- java.lang.Object
- org.springframework.web.socket.handler.WebSocketHandlerDecorator
- org.springframework.web.socket.handler.ExceptionWebSocketHandlerDecorator
- All Implemented Interfaces:
WebSocketHandler
public class ExceptionWebSocketHandlerDecorator extends WebSocketHandlerDecorator
An exception handlingWebSocketHandlerDecorator. Traps allThrowableinstances that escape from the decorated handler and closes the session withCloseStatus.SERVER_ERROR.- Since:
- 4.0
- Author:
- Rossen Stoyanchev
Constructor Summary
Constructors Constructor Description ExceptionWebSocketHandlerDecorator(WebSocketHandler delegate)
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidafterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred.voidafterConnectionEstablished(WebSocketSession session)Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.voidhandleMessage(WebSocketSession session, WebSocketMessage<?> message)Invoked when a new WebSocket message arrives.voidhandleTransportError(WebSocketSession session, Throwable exception)Handle an error from the underlying WebSocket message transport.static voidtryCloseWithError(WebSocketSession session, Throwable exception, Log logger)Methods inherited from class org.springframework.web.socket.handler.WebSocketHandlerDecorator
getDelegate, getLastHandler, supportsPartialMessages, toString, unwrap
Constructor Detail
ExceptionWebSocketHandlerDecorator
public ExceptionWebSocketHandlerDecorator(WebSocketHandler delegate)
Method Detail
afterConnectionEstablished
public void afterConnectionEstablished(WebSocketSession session)
Description copied from interface:WebSocketHandlerInvoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.- Specified by:
afterConnectionEstablishedin interfaceWebSocketHandler- Overrides:
afterConnectionEstablishedin classWebSocketHandlerDecorator
handleMessage
public void handleMessage(WebSocketSession session, WebSocketMessage<?> message)
Description copied from interface:WebSocketHandlerInvoked when a new WebSocket message arrives.- Specified by:
handleMessagein interfaceWebSocketHandler- Overrides:
handleMessagein classWebSocketHandlerDecorator
handleTransportError
public void handleTransportError(WebSocketSession session, Throwable exception)
Description copied from interface:WebSocketHandlerHandle an error from the underlying WebSocket message transport.- Specified by:
handleTransportErrorin interfaceWebSocketHandler- Overrides:
handleTransportErrorin classWebSocketHandlerDecorator
afterConnectionClosed
public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
Description copied from interface:WebSocketHandlerInvoked after the WebSocket connection has been closed by either side, or after a transport error has occurred. Although the session may technically still be open, depending on the underlying implementation, sending messages at this point is discouraged and most likely will not succeed.- Specified by:
afterConnectionClosedin interfaceWebSocketHandler- Overrides:
afterConnectionClosedin classWebSocketHandlerDecorator
tryCloseWithError
public static void tryCloseWithError(WebSocketSession session, Throwable exception, Log logger)