Module org.apache.wicket.websocket.core

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

Class AbstractWebSocketProcessor

java.lang.Object

org.apache.wicket.protocol.ws.api.AbstractWebSocketProcessor

All Implemented Interfaces:

IWebSocketProcessor

Direct Known Subclasses:

JavaxWebSocketProcessor

public abstract class AbstractWebSocketProcessor
extends Object
implements IWebSocketProcessor

The base implementation of IWebSocketProcessor. Provides the common logic for registering a web socket connection and broadcasting its events.

Since:

6.0

Constructor Summary

Constructors

Constructor	Description
AbstractWebSocketProcessor(jakarta.servlet.http.HttpServletRequest request, WebApplication application)	Constructor.

Method Summary

Modifier and Type	Method	Description
final void	broadcastMessage(IWebSocketMessage message)
final void	broadcastMessage(IWebSocketMessage message, IWebSocketConnection connection, boolean asynchronousPush, long timeout)	Exports the Wicket thread locals and broadcasts the received message from the client to all interested components and behaviors in the page with id #pageId
protected final WebApplication	getApplication()
protected IKey	getRegistryKey()
protected final String	getSessionId()
void	onClose(int closeCode, String message)	A notification after the close of the web socket connection.
protected final void	onConnect(IWebSocketConnection connection)	A helper that registers the opened connection in the application-level registry.
void	onError(Throwable t)	A notification after a communication error.
void	onMessage(byte[] data, int offset, int length)	Called when a binary message arrives from the client
void	onMessage(String message)	Called when a text message arrives from the client

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.protocol.ws.api.IWebSocketProcessor

onOpen, onOpen

Constructor Details

AbstractWebSocketProcessor

public AbstractWebSocketProcessor(jakarta.servlet.http.HttpServletRequest request,
 WebApplication application)

Constructor.

Parameters:

request - the http request that was used to create this IWebSocketProcessor

application - the current Wicket Application

Method Details

onMessage

public void onMessage(String message)

Description copied from interface: IWebSocketProcessor

Called when a text message arrives from the client

Specified by:

onMessage in interface IWebSocketProcessor

Parameters:

message - the text message from the client

onMessage

public void onMessage(byte[] data,
 int offset,
 int length)

Description copied from interface: IWebSocketProcessor

Called when a binary message arrives from the client

Specified by:

onMessage in interface IWebSocketProcessor

Parameters:

data - the binary message from the client

offset - the offset to read from

length - how much data to read

onConnect

protected final void onConnect(IWebSocketConnection connection)

A helper that registers the opened connection in the application-level registry.

Parameters:

connection - the web socket connection to use to communicate with the client

See Also:

• IWebSocketProcessor.onOpen(Object)

onClose

public void onClose(int closeCode,
 String message)

Description copied from interface: IWebSocketProcessor

A notification after the close of the web socket connection. The connection could be closed by either the client or the server

Specified by:

onClose in interface IWebSocketProcessor

Parameters:

closeCode - The close code

message - the message

onError

public void onError(Throwable t)

Description copied from interface: IWebSocketProcessor

A notification after a communication error.

Specified by:

onError in interface IWebSocketProcessor

Parameters:

t - The throwable for the communication problem

broadcastMessage

public final void broadcastMessage(IWebSocketMessage message)

broadcastMessage

public final void broadcastMessage(IWebSocketMessage message,
 IWebSocketConnection connection,
 boolean asynchronousPush,
 long timeout)

Exports the Wicket thread locals and broadcasts the received message from the client to all interested components and behaviors in the page with id #pageId

Note: ConnectedMessage and ClosedMessage messages are notification-only. I.e. whatever the components/behaviors write in the WebSocketRequestHandler will be ignored because the protocol doesn't expect response from the user.

Parameters:

message - the message to broadcast

connection - the IWebSocketConnection

asynchronousPush - whether asynchronous pus is used or not

timeout - The time ut to use for operation (in milliseconds). A negative value means use default timeout (specified by container).

getApplication

protected final WebApplication getApplication()

getSessionId

protected final String getSessionId()

getRegistryKey

protected IKey getRegistryKey()