Package org.apache.wicket.protocol.ws.api

Class WebSocketBehavior

  • All Implemented Interfaces:
    java.io.Serializable, org.apache.wicket.IComponentAwareEventSink, org.apache.wicket.markup.html.IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable
    public abstract class WebSocketBehavior
extends BaseWebSocketBehavior
    A behavior that provides optional callbacks for the WebSocket messages (connect, message, close)
    Since:
    6.0
    See Also:
    Serialized Form

    • Constructor Detail

      • WebSocketBehavior

        public WebSocketBehavior()

    • Method Detail

      • onEvent

        public void onEvent​(org.apache.wicket.Component component,
                    org.apache.wicket.event.IEvent<?> event)
        Specified by:
        onEvent in interface org.apache.wicket.IComponentAwareEventSink
        Overrides:
        onEvent in class org.apache.wicket.behavior.Behavior

      • onPush

        protected void onPush​(WebSocketRequestHandler handler,
                      IWebSocketPushMessage message)
        A callback method called when there is a message pushed/broadcasted by the server, e.g. pushed by a backend service
        Parameters:
        handler - The request handler that can be used to send messages to the client
        message - The message pushed/broadcasted by the server

      • onConnect

        protected void onConnect​(ConnectedMessage message)
        A callback method called when a WebSocket client has connected to the endpoint handled by this WebSocketBehavior
        Parameters:
        message - the connect message with the info about the client

      • onClose

        protected void onClose​(ClosedMessage message)
        A callback method called when a WebSocket client has closed the connection to the endpoint handled by this WebSocketBehavior
        Parameters:
        message - the close message with the info about the client

      • onError

        protected void onError​(WebSocketRequestHandler handler,
                       ErrorMessage message)
        A callback method called when there is a communication error
        Parameters:
        handler - The request handler that can be used to send messages to the client
        message - The error message that that brings information about the communication error

      • onAbort

        protected void onAbort​(AbortedMessage message)
        A callback method called when the server has aborted the connection
        Parameters:
        message - the aborted message with the info about the client

      • onMessage

        protected void onMessage​(WebSocketRequestHandler handler,
                         TextMessage message)
        A callback method called when there is a text message sent by the client
        Parameters:
        handler - The request handler that can be used to send messages back to the client
        message - The text message sent by the client

      • onMessage

        protected void onMessage​(WebSocketRequestHandler handler,
                         BinaryMessage binaryMessage)
        A callback method called when there is a binary message sent by the client
        Parameters:
        handler - The request handler that can be used to send messages back to the client
        binaryMessage - The binary message sent by the client