Class WebSocketClient

java.lang.Object

io.fluxzero.sdk.configuration.client.AbstractClient

io.fluxzero.sdk.configuration.client.WebSocketClient

All Implemented Interfaces:

Namespaced<Client>, Client

public class WebSocketClient
extends AbstractClient

A Client implementation that connects to the Fluxzero Runtime using WebSocket connections.

This client enables full integration with the Fluxzero Runtime by delegating all gateway, tracking, and subsystem communication to remote endpoints defined by the WebSocketClient.ClientConfig. It is typically used in production and testing environments where communication with the Fluxzero Runtime is required.

Usage

WebSocketClient client = WebSocketClient.newInstance(
    WebSocketClient.ClientConfig.builder()
        .runtimeBaseUrl("wss://my.fluxzero.host")
        .name("my-service")
        .build());
Fluxzero fluxzero = Fluxzero.builder().build(client);

See Also:

• DefaultFluxzero.builder()
• Client
• for an in-memory alternative

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebSocketClient.ClientConfig	Configuration class for creating a WebSocketClient.
static class	WebSocketClient.TrackingClientConfig	Configuration for a tracking client assigned to a specific MessageType.

Field Summary

Fields inherited from class AbstractClient

shutdownTasks

Constructor Summary

Constructors

Constructor	Description
WebSocketClient()

Method Summary

Modifier and Type	Method	Description
String	applicationId()	Returns the application ID under which this client instance is registered.
protected EventStoreClient	createEventStoreClient()	Subclasses must implement this method to return a EventStoreClient.
protected GatewayClient	createGatewayClient(MessageType messageType, String topic)	Subclasses must implement this method to return a GatewayClient for the given message type and topic.
protected KeyValueClient	createKeyValueClient()	Subclasses must implement this method to return a KeyValueClient.
protected SchedulingClient	createSchedulingClient()	Subclasses must implement this method to return a SchedulingClient.
protected SearchClient	createSearchClient()	Subclasses must implement this method to return a SearchClient.
protected TrackingClient	createTrackingClient(MessageType messageType, String topic)	Subclasses must implement this method to return a TrackingClient for the given message type and topic.
Client	forNamespace(String namespace)	Creates and returns the resource scoped to the specified namespace.
String	id()	Returns the unique identifier of this client instance.
String	name()	Returns the name of this client as defined in its configuration.
String	namespace()	Returns the namespace associated with this client instance.
static WebSocketClient	newInstance(WebSocketClient.ClientConfig clientConfig)
void	shutDown()	Shuts down this client instance, releasing any underlying resources.

Methods inherited from class AbstractClient

beforeShutdown, getGatewayClient, getTrackingClient, monitorDispatch

Methods inherited from class Object

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

Methods inherited from interface Client

getEventStoreClient, getGatewayClient, getKeyValueClient, getSchedulingClient, getSearchClient, getTrackingClient, unwrap

Methods inherited from interface Namespaced

forDefaultNamespace

Constructor Details

WebSocketClient

public WebSocketClient()

Method Details

newInstance

public static WebSocketClient newInstance(WebSocketClient.ClientConfig clientConfig)

name

public String name()

Description copied from interface: Client

Returns the name of this client as defined in its configuration.

id

public String id()

Description copied from interface: Client

Returns the unique identifier of this client instance. This id may be randomly generated.

applicationId

public String applicationId()

Description copied from interface: Client

Returns the application ID under which this client instance is registered.

namespace

public String namespace()

Description copied from interface: Client

Returns the namespace associated with this client instance.

forNamespace

public Client forNamespace(String namespace)

Description copied from interface: Namespaced

Creates and returns the resource scoped to the specified namespace.

Parameters:

namespace - the namespace to which the returned resource is scoped

Returns:

the resource associated with the specified namespace

createGatewayClient

protected GatewayClient createGatewayClient(MessageType messageType,
 String topic)

Description copied from class: AbstractClient

Subclasses must implement this method to return a GatewayClient for the given message type and topic.

Specified by:

createGatewayClient in class AbstractClient

createTrackingClient

protected TrackingClient createTrackingClient(MessageType messageType,
 String topic)

Description copied from class: AbstractClient

Subclasses must implement this method to return a TrackingClient for the given message type and topic.

Specified by:

createTrackingClient in class AbstractClient

createEventStoreClient

protected EventStoreClient createEventStoreClient()

Description copied from class: AbstractClient

Subclasses must implement this method to return a EventStoreClient.

Specified by:

createEventStoreClient in class AbstractClient

createSchedulingClient

protected SchedulingClient createSchedulingClient()

Description copied from class: AbstractClient

Subclasses must implement this method to return a SchedulingClient.

Specified by:

createSchedulingClient in class AbstractClient

createKeyValueClient

protected KeyValueClient createKeyValueClient()

Description copied from class: AbstractClient

Subclasses must implement this method to return a KeyValueClient.

Specified by:

createKeyValueClient in class AbstractClient

createSearchClient

protected SearchClient createSearchClient()

Description copied from class: AbstractClient

Subclasses must implement this method to return a SearchClient.

Specified by:

createSearchClient in class AbstractClient

shutDown

public void shutDown()

Description copied from interface: Client

Shuts down this client instance, releasing any underlying resources.

This includes closing websocket sessions, stopping tracking, and executing registered shutdown hooks.

Specified by:

shutDown in interface Client

Overrides:

shutDown in class AbstractClient