org.apache.wicket.protocol.ws.api
Class WebSocketBehavior

java.lang.Object
  org.apache.wicket.behavior.Behavior
      org.apache.wicket.protocol.ws.api.BaseWebSocketBehavior
          org.apache.wicket.protocol.ws.api.WebSocketBehavior

All Implemented Interfaces:

Serializable, IComponentAwareEventSink, 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 Summary

WebSocketBehavior()

Method Summary

protected void	onClose(ClosedMessage message) A callback method called when a WebSocket client has closed the connection to the endpoint handled by this WebSocketBehavior
protected void	onConnect(ConnectedMessage message) A callback method called when a WebSocket client has connected to the endpoint handled by this WebSocketBehavior
void	onEvent(Component component, IEvent<?> event)
protected void	onMessage(WebSocketRequestHandler handler, BinaryMessage binaryMessage) A callback method called when there is a binary message sent by the client
protected void	onMessage(WebSocketRequestHandler handler, TextMessage message) A callback method called when there is a text message sent by the client
protected void	onPush(WebSocketRequestHandler handler, IWebSocketPushMessage message) A callback method called when there is a message pushed/broadcasted by the server, e.g.

Methods inherited from class org.apache.wicket.protocol.ws.api.BaseWebSocketBehavior

getStatelessHint, renderHead

Methods inherited from class org.apache.wicket.behavior.Behavior

afterRender, beforeRender, bind, canCallListenerInterface, detach, isEnabled, isTemporary, onComponentTag, onConfigure, onException, onRemove, unbind

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketBehavior

public WebSocketBehavior()

Method Detail

onEvent

public void onEvent(Component component,
                    IEvent<?> event)

Specified by:

onEvent in interface IComponentAwareEventSink

Overrides:

onEvent in class 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

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