Package io.deephaven.enterprise.dnd

Interface EnterpriseJettyComponent.Builder

All Superinterfaces:
DeephavenApiServerComponent.Builder<EnterpriseJettyComponent.Builder,EnterpriseJettyComponent>
Enclosing interface:
EnterpriseJettyComponent
@Builder public static interface EnterpriseJettyComponent.Builder extends DeephavenApiServerComponent.Builder<EnterpriseJettyComponent.Builder,EnterpriseJettyComponent>
The root builder for the DnD jetty component.

  • Method Details

    • withJettyConfig

      @BindsInstance EnterpriseJettyComponent.Builder withJettyConfig(@NotNull @NotNull JettyConfig config)
      Set the Jetty configuration to use for the server.
      Parameters:
      config - the configuration
      Returns:
      this builder

    • withEnterpriseConfiguration

      @BindsInstance EnterpriseJettyComponent.Builder withEnterpriseConfiguration(@NotNull io.deephaven.shadow.enterprise.com.fishlib.configuration.Configuration configuration)
      Set the Enterprise configuration object.

    • withUserContext

      @BindsInstance EnterpriseJettyComponent.Builder withUserContext(@Named("auth.serverCredentials") UserContext context)
      Set the user context of the owning user
      Parameters:
      context - the context
      Returns:
      this builder

    • withAdminGroups

      @BindsInstance EnterpriseJettyComponent.Builder withAdminGroups(@Named("auth.adminGroups") @NotNull @NotNull Set<String> adminGroups)

    • withViewerGroups

      @BindsInstance EnterpriseJettyComponent.Builder withViewerGroups(@Named("auth.viewerGroups") @NotNull @NotNull Set<String> viewerGroups)

    • withPqName

      @BindsInstance EnterpriseJettyComponent.Builder withPqName(@Named("persistentQueryName") @Nullable String persistentQueryName)

    • enforceSessionCount

      @BindsInstance EnterpriseJettyComponent.Builder enforceSessionCount(@Named("enforceSessionCount") int enforceSessionCount)
      Set if the worker should time out when there are fewer than enforceSessionCount active sessions.
      Parameters:
      enforceSessionCount - true if the worker should time out
      Returns:
      this builder

    • sessionTimeoutMillis

      @BindsInstance EnterpriseJettyComponent.Builder sessionTimeoutMillis(@Nullable @Named("sessionTimeoutMillis") Long sessionTimeoutMillis)
      How long is the session timeout grace period.
      Parameters:
      sessionTimeoutMillis - how many millis after the last session terminates should we terminate
      Returns:
      this builder

    • pushSessionChanges

      @BindsInstance EnterpriseJettyComponent.Builder pushSessionChanges(@Named("pushSessionChanges") boolean pushSessionChanges)
      Set if the worker should push session changes to the controller.
      Parameters:
      pushSessionChanges - true if the worker should push session changes to the controller
      Returns:
      this builder

    • autoDelete

      @BindsInstance EnterpriseJettyComponent.Builder autoDelete(@Named("queryAutoDelete") Boolean autoDelete)
      Set if the worker should delete its corresponding query on shutdown
      Parameters:
      autoDelete - true if the worker should auto delete the corresponding query on shutdown
      Returns:
      this builder

    • withDispatcherClient

      @BindsInstance EnterpriseJettyComponent.Builder withDispatcherClient(@NotNull @NotNull io.deephaven.enterprise.dispatcher.client.DispatcherClient dispatcherClient)
      Set the DispatcherClient for components.
      Parameters:
      dispatcherClient - the dispatcher client
      Returns:
      this builder

    • withEtcdClient

      @BindsInstance EnterpriseJettyComponent.Builder withEtcdClient(@NotNull @NotNull io.deephaven.shadow.jetcd.io.etcd.jetcd.Client etcdClient)
      Set the Client which can be used for worker etcd operations.
      Parameters:
      etcdClient - an etcd client that is suitably permissioned for worker roles
      Returns:
      this builder

    • withAuditEventLogger

      @BindsInstance EnterpriseJettyComponent.Builder withAuditEventLogger(@NotNull @NotNull AuditEventLogger auditEventLogger)
      Parameters:
      auditEventLogger - AuditEventLogger instance to be used as needed, e.g. upon DatabaseImpl provision
      Returns:
      this builder

    • withPersistentQuerySerial

      @BindsInstance EnterpriseJettyComponent.Builder withPersistentQuerySerial(@Named("persistentQuerySerial") long persistentQuerySerial)
      Parameters:
      persistentQuerySerial - the persistent query serial that we are running, -1 for non-pq workers
      Returns:
      this builder

    • withPersistentQueryScriptPathLoaderState

      @BindsInstance EnterpriseJettyComponent.Builder withPersistentQueryScriptPathLoaderState(@Nullable @Named("persistentQueryScriptPathLoaderState") String persistentQueryScriptPathLoaderState)
      Parameters:
      persistentQueryScriptPathLoaderState - the persistent query script path loader state, null for non-pq workers
      Returns:
      this builder

    • withVirtualEnvironment

      @BindsInstance EnterpriseJettyComponent.Builder withVirtualEnvironment(@Nullable @Named("virtualEnvironment") String virtualEnvironment)

    • trustAll

      @BindsInstance EnterpriseJettyComponent.Builder trustAll(@Named("trustAll") boolean trustAll)
      Set if the worker should ignore the truststore with regard for PQ uri resolution.
      Parameters:
      trustAll - true if the worker should trust without regard to a truststore for uri resolution
      Returns:
      this builder

    • withCacheDir

      @BindsInstance EnterpriseJettyComponent.Builder withCacheDir(@Named("cacheDir") File cacheDir)
      Parameters:
      cacheDir - the worker's temporary cache dir
      Returns:
      this builder

    • withProcessInfo

      @BindsInstance EnterpriseJettyComponent.Builder withProcessInfo(ProcessInfo processInfo)
      Parameters:
      processInfo - the worker's pel info
      Returns:
      this builder

    • withReplaySettings

      @BindsInstance EnterpriseJettyComponent.Builder withReplaySettings(@Nullable io.deephaven.shadow.enterprise.com.illumon.iris.db.tables.databases.ReplaySettings replaySettings)

    • build

      EnterpriseJettyComponent build()
      Specified by:
      build in interface DeephavenApiServerComponent.Builder<EnterpriseJettyComponent.Builder,EnterpriseJettyComponent>