Class CitrusWebSocketHandler

  • All Implemented Interfaces:
    org.springframework.web.socket.WebSocketHandler

    public class CitrusWebSocketHandler
    extends org.springframework.web.socket.handler.AbstractWebSocketHandler
    Web Socket Handler for handling incoming and sending outgoing Web Socket messages
    Since:
    2.3
    Author:
    Martin Maher
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void afterConnectionClosed​(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.CloseStatus status)  
      void afterConnectionEstablished​(org.springframework.web.socket.WebSocketSession session)  
      org.springframework.web.socket.WebSocketMessage<?> getMessage()
      Polls message from internal cache.
      protected void handleBinaryMessage​(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.BinaryMessage message)  
      protected void handlePongMessage​(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.PongMessage message)  
      protected void handleTextMessage​(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.TextMessage message)  
      void handleTransportError​(org.springframework.web.socket.WebSocketSession session, Throwable exception)  
      boolean sendMessage​(org.springframework.web.socket.WebSocketMessage<?> message)
      Publish message to all sessions known to this handler.
      • Methods inherited from class org.springframework.web.socket.handler.AbstractWebSocketHandler

        handleMessage, supportsPartialMessages
    • Constructor Detail

      • CitrusWebSocketHandler

        public CitrusWebSocketHandler()
    • Method Detail

      • afterConnectionEstablished

        public void afterConnectionEstablished​(org.springframework.web.socket.WebSocketSession session)
                                        throws Exception
        Specified by:
        afterConnectionEstablished in interface org.springframework.web.socket.WebSocketHandler
        Overrides:
        afterConnectionEstablished in class org.springframework.web.socket.handler.AbstractWebSocketHandler
        Throws:
        Exception
      • handleTextMessage

        protected void handleTextMessage​(org.springframework.web.socket.WebSocketSession session,
                                         org.springframework.web.socket.TextMessage message)
                                  throws Exception
        Overrides:
        handleTextMessage in class org.springframework.web.socket.handler.AbstractWebSocketHandler
        Throws:
        Exception
      • handleBinaryMessage

        protected void handleBinaryMessage​(org.springframework.web.socket.WebSocketSession session,
                                           org.springframework.web.socket.BinaryMessage message)
                                    throws Exception
        Overrides:
        handleBinaryMessage in class org.springframework.web.socket.handler.AbstractWebSocketHandler
        Throws:
        Exception
      • handlePongMessage

        protected void handlePongMessage​(org.springframework.web.socket.WebSocketSession session,
                                         org.springframework.web.socket.PongMessage message)
                                  throws Exception
        Overrides:
        handlePongMessage in class org.springframework.web.socket.handler.AbstractWebSocketHandler
        Throws:
        Exception
      • handleTransportError

        public void handleTransportError​(org.springframework.web.socket.WebSocketSession session,
                                         Throwable exception)
                                  throws Exception
        Specified by:
        handleTransportError in interface org.springframework.web.socket.WebSocketHandler
        Overrides:
        handleTransportError in class org.springframework.web.socket.handler.AbstractWebSocketHandler
        Throws:
        Exception
      • afterConnectionClosed

        public void afterConnectionClosed​(org.springframework.web.socket.WebSocketSession session,
                                          org.springframework.web.socket.CloseStatus status)
                                   throws Exception
        Specified by:
        afterConnectionClosed in interface org.springframework.web.socket.WebSocketHandler
        Overrides:
        afterConnectionClosed in class org.springframework.web.socket.handler.AbstractWebSocketHandler
        Throws:
        Exception
      • getMessage

        public org.springframework.web.socket.WebSocketMessage<?> getMessage()
        Polls message from internal cache.
        Returns:
      • sendMessage

        public boolean sendMessage​(org.springframework.web.socket.WebSocketMessage<?> message)
        Publish message to all sessions known to this handler.
        Parameters:
        message -
        Returns: