Package io.deephaven.enterprise.dnd

Class ControllerClientFactory

java.lang.Object

io.deephaven.enterprise.dnd.ControllerClientFactory

All Implemented Interfaces:

PersistentQueryControllerClientFactory

@Module
public class ControllerClientFactory
extends Object
implements PersistentQueryControllerClientFactory

A lazy provider of the singleton controller client for queries. Some operations require the controller client, and we do not want to create one unless it is necessary, or create more than one to avoid additional controller load. The client is currently used for:

• PQ URI resolution.
• Variable updates.
• Heartbeat requests
• Script requests

Constructor Summary

Constructors

Constructor	Description
ControllerClientFactory(@NotNull AuthenticationClient authClient, @Nullable io.deephaven.shadow.jetcd.io.etcd.jetcd.Client etcdClient, @Nullable String name)

Method Summary

Modifier and Type	Method	Description
PersistentQueryControllerClient	getSubscribed()	Get a controller client that is subscribed to all queries.
PersistentQueryControllerClient	getUnsubscribed()	Get a (possibly) unsubscribed controller client.
static ControllerClientFactory	makeControllerClientFactory()
static ControllerClientFactory	makeControllerClientFactory(@NotNull AuthenticationClient authClient, @NotNull io.deephaven.shadow.jetcd.io.etcd.jetcd.Client etcdClient, @NotNull ProcessInfo info)
static ControllerClientFactory	makeControllerClientFactory(@Nullable String name)

Methods inherited from class java.lang.Object

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

Constructor Details

ControllerClientFactory

public ControllerClientFactory(@NotNull
 @NotNull AuthenticationClient authClient,
 @Nullable
 @Nullable io.deephaven.shadow.jetcd.io.etcd.jetcd.Client etcdClient,
 @Nullable
 @Nullable String name)

Method Details

makeControllerClientFactory

@Provides
@Singleton
public static ControllerClientFactory makeControllerClientFactory(@NotNull
 @NotNull AuthenticationClient authClient,
 @NotNull
 @NotNull io.deephaven.shadow.jetcd.io.etcd.jetcd.Client etcdClient,
 @NotNull
 @NotNull ProcessInfo info)

makeControllerClientFactory

public static ControllerClientFactory makeControllerClientFactory(@Nullable
 @Nullable String name)

makeControllerClientFactory

public static ControllerClientFactory makeControllerClientFactory()

getUnsubscribed

public PersistentQueryControllerClient getUnsubscribed()

Get a (possibly) unsubscribed controller client.

Specified by:

getUnsubscribed in interface PersistentQueryControllerClientFactory

Returns:

a controller client

getSubscribed

public PersistentQueryControllerClient getSubscribed()

Get a controller client that is subscribed to all queries.

Specified by:

getSubscribed in interface PersistentQueryControllerClientFactory

Returns:

a subscribed controller client.