Package com.cumulocity.sdk.client.notification2.internal

Class WebSocketClient

java.lang.Object

com.cumulocity.sdk.client.notification2.internal.WebSocketClient

All Implemented Interfaces:

WebSocketConnectorListener

public class WebSocketClient
extends Object
implements WebSocketConnectorListener

This class is responsible for establishing and maintaining a websocket connection + connection token management. It also notifies about received messages (notifications). An instance of this class is created per subscription.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESSAGE_SHUTDOWN
static final String	MESSAGE_TOKEN_REFRESH

Constructor Summary

Constructors

Constructor	Description
WebSocketClient(String webSocketBaseUrl, String subscriber, String subscriptionName, AckMode ackMode, String tenantId, String deviceId, NotificationListener notificationListener, Duration reconnectDelay, Duration tokenRefreshInterval, boolean isTokenShared, boolean isTokenPersistent, TokenApi tokenApi, WebSocketConnector connector)

Method Summary

Modifier and Type	Method	Description
Object	getRawWebSocket()
boolean	isRunning()
void	onWebsocketClosed(int code, String reason)	connection closed
void	onWebsocketError(Throwable t)	connection error
void	onWebsocketMessage(String text)	message received
void	onWebsocketOpen()	connection established
void	start()	Connects to web socket and schedules token refresh job package private
void	stop(boolean unsubscribe)	Disconnects and stops the client including scheduled jobs for reconnection and token refresh

Methods inherited from class java.lang.Object

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

Field Details

MESSAGE_TOKEN_REFRESH

public static final String MESSAGE_TOKEN_REFRESH

See Also:

• Constant Field Values

MESSAGE_SHUTDOWN

public static final String MESSAGE_SHUTDOWN

See Also:

• Constant Field Values

Constructor Details

WebSocketClient

public WebSocketClient(String webSocketBaseUrl,
 String subscriber,
 String subscriptionName,
 AckMode ackMode,
 String tenantId,
 String deviceId,
 NotificationListener notificationListener,
 Duration reconnectDelay,
 Duration tokenRefreshInterval,
 boolean isTokenShared,
 boolean isTokenPersistent,
 TokenApi tokenApi,
 WebSocketConnector connector)

Method Details

start

public void start()

Connects to web socket and schedules token refresh job package private

stop

public void stop(boolean unsubscribe)

Disconnects and stops the client including scheduled jobs for reconnection and token refresh

onWebsocketClosed

public void onWebsocketClosed(int code,
 String reason)

Description copied from interface: WebSocketConnectorListener

connection closed

Specified by:

onWebsocketClosed in interface WebSocketConnectorListener

Parameters:

code - closing code

reason - closing reason

onWebsocketError

public void onWebsocketError(Throwable t)

Description copied from interface: WebSocketConnectorListener

connection error

Specified by:

onWebsocketError in interface WebSocketConnectorListener

Parameters:

t - exception details

onWebsocketOpen

public void onWebsocketOpen()

Description copied from interface: WebSocketConnectorListener

connection established

Specified by:

onWebsocketOpen in interface WebSocketConnectorListener

onWebsocketMessage

public void onWebsocketMessage(String text)

Description copied from interface: WebSocketConnectorListener

message received

Specified by:

onWebsocketMessage in interface WebSocketConnectorListener

Parameters:

text - message text

getRawWebSocket

public Object getRawWebSocket()

isRunning

public boolean isRunning()