Package io.deephaven.enterprise.dnd.client

Class DndSessionFactoryBarrage

java.lang.Object

io.deephaven.enterprise.dnd.client.DndSessionFactoryBarrage

public class DndSessionFactoryBarrage
extends Object

A factory class for creating barrage sessions.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.arrow.memory.RootAllocator	incomingAllocator

Constructor Summary

Constructors

Constructor	Description
DndSessionFactoryBarrage(@NotNull String serverUrl)	Create a new DndSessionFactoryBarrage for fetching barrage tables from a Persistent Query

Method Summary

Modifier and Type	Method	Description
void	close()	Close all resources and connections with the server.
PersistentQueryConfigMessage.Builder	createPersistentQueryConfig(@NotNull String name, float heapSizeGb, long autoDeleteTimeoutMillis)	Create a new Interactive Console Persistent Query configuration with a language set to `Python`
void	delegateToken()	Use a delegate token to authenticate; automatically calling the default AuthenticationClientManager.
void	delegateToken(@NotNull AuthToken delegateToken)	Use a delegate token to authenticate.
protected void	doOnAuthenticated()
DeephavenClusterConnection	getConnection()
@Nullable PersistentQueryInfoMessage	getPQ(long serial)	Get a PersistentQueryInfoMessage for the specified PQ serial.
@Nullable PersistentQueryInfoMessage	getPQ(@NotNull String name)	Get a PersistentQueryInfoMessage for the specified PQ name.
protected DndSessionBarrage	makeSession(PersistentQueryInfoMessage qConfig, AuthToken authToken, boolean deleteOnClose, DeephavenClusterConnection connection)
DndSessionBarrage	newWorker(@NotNull PersistentQueryConfigMessage message, long startupTimeoutMillis)	Create a new Interactive Console Persistent Query session.
DndSessionBarrage	newWorker(@NotNull String name, float heapSizeGb, long autoDeleteTimeoutMillis, long startupTimeoutMillis)
void	password(@NotNull String user, @NotNull String password)	Authenticate with the server using a username and password
DndSessionBarrage	persistentQuery(long serial)	Create a new DndSession to the specified Persistent Query by serial.
DndSessionBarrage	persistentQuery(@NotNull String name)	Create a new DndSession to the specified Persistent Query by name.
void	privateKey(@NotNull String keyFile)	Authenticate to the server using a private key file.
void	setIncomingAllocator(@NotNull org.apache.arrow.memory.RootAllocator incomingAllocator)	Set the incoming allocator for this factory.
void	setMaxInboundMessageSize(int maxInboundMessageSize)

Methods inherited from class java.lang.Object

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

Field Details

incomingAllocator

protected org.apache.arrow.memory.RootAllocator incomingAllocator

Constructor Details

DndSessionFactoryBarrage

public DndSessionFactoryBarrage(@NotNull
 @NotNull String serverUrl)
                         throws IOException

Create a new DndSessionFactoryBarrage for fetching barrage tables from a Persistent Query

Parameters:

serverUrl - the url to the server

Throws:

IOException - if there was a problem connecting to the server

Method Details

doOnAuthenticated

protected void doOnAuthenticated()

makeSession

protected DndSessionBarrage makeSession(PersistentQueryInfoMessage qConfig,
 AuthToken authToken,
 boolean deleteOnClose,
 DeephavenClusterConnection connection)
                                 throws IOException

Throws:

IOException

close

public void close()

Close all resources and connections with the server.

setIncomingAllocator

public void setIncomingAllocator(@NotNull
 @NotNull org.apache.arrow.memory.RootAllocator incomingAllocator)

Set the incoming allocator for this factory. This allocator is used as the root allocator for the flight client of the DndSession. Otherwise, the flight client will instantiate a new RootAllocator to use. This setter must be called before the concrete makeSession(io.deephaven.proto.controller.PersistentQueryInfoMessage, io.deephaven.enterprise.auth.AuthToken, boolean, io.deephaven.enterprise.dnd.client.DeephavenClusterConnection) is called if you want to use the incoming allocator for the flight client.

Parameters:

incomingAllocator - the RootAllocator to use for flight client

getConnection

public DeephavenClusterConnection getConnection()

Returns:

the DeephavenClusterConnection used by this factory to connect to the server.

password

public void password(@NotNull
 @NotNull String user,
 @NotNull
 @NotNull String password)

Authenticate with the server using a username and password

Parameters:

user - the username

password - the password

privateKey

public void privateKey(@NotNull
 @NotNull String keyFile)

Authenticate to the server using a private key file.

Parameters:

keyFile - the private key file

delegateToken

public void delegateToken(@NotNull
 @NotNull AuthToken delegateToken)

Use a delegate token to authenticate.

delegateToken

public void delegateToken()

Use a delegate token to authenticate; automatically calling the default AuthenticationClientManager.

This is suitable for use within a single Deephaven cluster, when one authenticated worker should connect as the same user to another worker.

createPersistentQueryConfig

public PersistentQueryConfigMessage.Builder createPersistentQueryConfig(@NotNull
 @NotNull String name,
 float heapSizeGb,
 long autoDeleteTimeoutMillis)

Create a new Interactive Console Persistent Query configuration with a language set to `Python`

Parameters:

name - the name to create with

heapSizeGb - the desired heap size in GB

autoDeleteTimeoutMillis - how long the query should remain if all clients disconnect

Returns:

a new PersistentQueryConfigMessage.Builder to use with newWorker(PersistentQueryConfigMessage, long)

newWorker

public DndSessionBarrage newWorker(@NotNull
 @NotNull String name,
 float heapSizeGb,
 long autoDeleteTimeoutMillis,
 long startupTimeoutMillis)
                            throws IOException

Throws:

IOException

newWorker

public DndSessionBarrage newWorker(@NotNull
 @NotNull PersistentQueryConfigMessage message,
 long startupTimeoutMillis)
                            throws IOException

Create a new Interactive Console Persistent Query session.

Parameters:

message - the PersistentQueryInfoMessage to create the Persistent Query with

startupTimeoutMillis - the timeout for starting the query

Returns:

a new DndSessionFactoryBase for communicating with the Persistent Query.

Throws:

IOException - if there was a problem creating the Persistent Query

persistentQuery

public DndSessionBarrage persistentQuery(@NotNull
 @NotNull String name)
                                  throws IOException

Create a new DndSession to the specified Persistent Query by name.

Parameters:

name - the name of the Persistent Query

Returns:

a new DndSession for communicating with the Persistent Query.

Throws:

IOException - if there was a problem creating the Persistent Query

persistentQuery

public DndSessionBarrage persistentQuery(long serial)
                                  throws IOException

Create a new DndSession to the specified Persistent Query by serial.

Parameters:

serial - the name of the Persistent Query

Returns:

a new DndSession for communicating with the Persistent Query.

Throws:

IOException - if there was a problem creating the Persistent Query

setMaxInboundMessageSize

public void setMaxInboundMessageSize(int maxInboundMessageSize)

getPQ

@Nullable
public @Nullable PersistentQueryInfoMessage getPQ(long serial)

Get a PersistentQueryInfoMessage for the specified PQ serial.

Parameters:

serial - the PQ's serial

Returns:

the PersistentQueryInfoMessage, or null if the PQ doesn't exist

getPQ

@Nullable
public @Nullable PersistentQueryInfoMessage getPQ(@NotNull
 @NotNull String name)

Get a PersistentQueryInfoMessage for the specified PQ name.

Parameters:

name - the PQ's name

Returns:

the PersistentQueryInfoMessage, or null if the PQ doesn't exist