Package io.deephaven.enterprise.dnd.client

Class DndSessionFactoryFlight

java.lang.Object

io.deephaven.enterprise.dnd.client.DndSessionFactoryFlight

public class DndSessionFactoryFlight
extends Object

A factory class for creating flight sessions.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DndSessionFactoryFlight(String serverUrl)	Create a new DndSessionFactoryFlight for fetching FlightStreams from a Persistent Query

Method Summary

Modifier and Type	Method	Description
void	close()	Close all resources and connections with the server.
PersistentQueryConfigMessage.Builder	createPersistentQueryConfig(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(AuthToken delegateToken)	Use a delegate token to authenticate.
protected void	doOnAuthenticated()
DeephavenClusterConnection	getConnection()
PersistentQueryInfoMessage	getPQ(long serial)	Get a PersistentQueryInfoMessage for the specified PQ serial.
PersistentQueryInfoMessage	getPQ(String name)	Get a PersistentQueryInfoMessage for the specified PQ name.
protected DndSessionFlight	makeSession(PersistentQueryInfoMessage qConfig, AuthToken authToken, boolean deleteOnClose, DeephavenClusterConnection connection)
DndSessionFlight	newWorker(PersistentQueryConfigMessage message, long startupTimeoutMillis)	Create a new Interactive Console Persistent Query session.
DndSessionFlight	newWorker(String name, float heapSizeGb, long autoDeleteTimeoutMillis, long startupTimeoutMillis)
void	password(String user, String password)	Authenticate with the server using a username and password
DndSessionFlight	persistentQuery(long serial)	Create a new DndSession to the specified Persistent Query by serial.
DndSessionFlight	persistentQuery(String name)	Create a new DndSession to the specified Persistent Query by name.
void	privateKey(String keyFile)	Authenticate to the server using a private key file.
void	setIncomingAllocator(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

DndSessionFactoryFlight

public DndSessionFactoryFlight(@NotNull
 String serverUrl)
                        throws IOException

Create a new DndSessionFactoryFlight for fetching FlightStreams from a Persistent Query

Parameters:

serverUrl - the url to the server

Throws:

IOException - if there was a problem connecting to the server

Method Details

makeSession

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

Throws:

IOException

setIncomingAllocator

public void setIncomingAllocator(@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
 String user,
 @NotNull
 String password)

Authenticate with the server using a username and password

Parameters:

user - the username

password - the password

privateKey

public void privateKey(@NotNull
 String keyFile)

Authenticate to the server using a private key file.

Parameters:

keyFile - the private key file

delegateToken

public void delegateToken(@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.

close

@OverridingMethodsMustInvokeSuper
public void close()

Close all resources and connections with the server.

createPersistentQueryConfig

public PersistentQueryConfigMessage.Builder createPersistentQueryConfig(@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 DndSessionFlight newWorker(@NotNull
 String name,
 float heapSizeGb,
 long autoDeleteTimeoutMillis,
 long startupTimeoutMillis)
                           throws IOException

Throws:

IOException

newWorker

public DndSessionFlight newWorker(@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 DndSessionFlight persistentQuery(@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 DndSessionFlight 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)

doOnAuthenticated

protected void doOnAuthenticated()

getPQ

@Nullable
public 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 PersistentQueryInfoMessage getPQ(@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