deephaven_server.server¶

class AuthenticationHandler(j_authentication_handler)[source]¶

Bases: object

Represents an authentication handler for a Deephaven server.

property auth_type¶

Get the authentication type for this handler.

urls(target_url)[source]¶

Get the URLs for this authentication handler.

Parameters:: target_url (str) – The target URL where the Web UI is hosted.
Return type:: List[str]
Returns:: The URLs provided by this authentication handler to open the Web UI with authentication. For example, with pre-shared key authentication, it could add a query param with the pre-shared key.

class Server(host=None, port=None, jvm_args=None, extra_classpath=None)[source]¶

Bases: object

Represents a Deephaven server that can be created from Python.

property authentication_handlers¶

Get the authentication handlers for the server.

property port¶

Get the port the server is running on.

property server_config¶

Get the configuration of the server.

start()[source]¶: Starts the server. Presently once the server is started, it cannot be stopped until the python process halts.

class ServerConfig(j_server_config)[source]¶

Bases: object

Represents the configuration of a Deephaven server.

property target_url_or_default¶

Returns the target URL to bring up the Web UI.