Package io.deephaven.enterprise.dnd.controller

Interface PersistentQueryScriptSource

All Known Subinterfaces:
PersistentQueryControllerClient
All Known Implementing Classes:
PersistentQueryControllerClientImpl
public interface PersistentQueryScriptSource
Implementations of this class provide a way to access script code and paths for execution.

  • Method Summary

    Modifier and Type
    Method
    Description
    default @Nullable String
    getScriptBody(@NotNull String scriptPath, boolean isPathRelative)
    Get the body of the specified script as the currently authenticated user.
    @Nullable String
    getScriptBody(@NotNull String scriptPath, boolean isPathRelative, @Nullable String scriptLoaderStateJson)
    Get the body of the specified script as the currently authenticated user.
    default @Nullable String
    getScriptBodyByQuery(@NotNull String scriptPath, long querySerial, boolean isPathRelative)
    Get a script by path for the owner of a specific query by serial.
    @Nullable String
    getScriptBodyByQuery(@NotNull String scriptPath, long querySerial, boolean isPathRelative, @Nullable String scriptLoaderStateJson)
    Get a script by path for the owner of a specific query by serial, with optional script loader state information.
    default @Nullable String
    getScriptBodyByUser(@NotNull String scriptPath, @NotNull String userName, boolean isPathRelative)
    Get the body of the specified script as the specified user.
    @Nullable String
    getScriptBodyByUser(@NotNull String scriptPath, @NotNull String userName, boolean isPathRelative, @Nullable String scriptLoaderStateJson)
    Get the body of the specified script as the specified user.
    default @NotNull Set<String>
    getScriptPaths(boolean useRelativePath)
    Get all script paths available for the currently authenticated user.
    @NotNull Set<String>
    getScriptPaths(@Nullable String scriptLoaderStateJson, boolean useRelativePath)
    Get all script paths available for the currently authenticated user.
    default @NotNull Set<String>
    getScriptPathsByQuery(long querySerial, boolean useRelativePath)
    Get all script paths available to the owner of a specific query by serial.
    @NotNull Set<String>
    getScriptPathsByQuery(long configSerial, @Nullable String scriptLoaderStateJson, boolean useRelativePath)
    Get all script paths available to the owner of a specific query by serial, providing optional script loader state information.
    default @NotNull Set<String>
    getScriptPathsByUser(@NotNull String userName, boolean useRelativePath)
    Get the script paths available for the specified user.
    @NotNull Set<String>
    getScriptPathsByUser(@NotNull String userName, @Nullable String scriptLoaderStateJson, boolean useRelativePath)
    Get the script paths available for the specified user.

  • Method Details

    • getScriptPathsByUser

      @FinalDefault @NotNull default @NotNull Set<String> getScriptPathsByUser(@NotNull @NotNull String userName, boolean useRelativePath)
      Get the script paths available for the specified user.
      Parameters:
      userName - the user to fetch paths for
      useRelativePath - whether to return relative or display script paths
      Returns:
      the set of paths available for the specified user

    • getScriptPathsByUser

      @NotNull @NotNull Set<String> getScriptPathsByUser(@NotNull @NotNull String userName, @Nullable @Nullable String scriptLoaderStateJson, boolean useRelativePath)
      Get the script paths available for the specified user.
      Parameters:
      userName - the user to fetch paths for
      scriptLoaderStateJson - optional script loader state information
      useRelativePath - whether to return relative or display script paths
      Returns:
      the set of paths available for the specified user

    • getScriptPathsByQuery

      @FinalDefault @NotNull default @NotNull Set<String> getScriptPathsByQuery(long querySerial, boolean useRelativePath)
      Get all script paths available to the owner of a specific query by serial.
      Parameters:
      querySerial - the query serial
      useRelativePath - whether to return relative or display script paths
      Returns:
      The paths available to the query serial.

    • getScriptPathsByQuery

      @NotNull @NotNull Set<String> getScriptPathsByQuery(long configSerial, @Nullable @Nullable String scriptLoaderStateJson, boolean useRelativePath)
      Get all script paths available to the owner of a specific query by serial, providing optional script loader state information.
      Parameters:
      configSerial - the query serial
      scriptLoaderStateJson - an optional loader state
      useRelativePath - whether to return relative or display script paths
      Returns:
      The paths available to the serial ID.

    • getScriptPaths

      @NotNull @FinalDefault default @NotNull Set<String> getScriptPaths(boolean useRelativePath)
      Get all script paths available for the currently authenticated user.
      Parameters:
      useRelativePath - whether to return relative or display script paths
      Returns:
      the set of paths available for the current user

    • getScriptPaths

      @NotNull @NotNull Set<String> getScriptPaths(@Nullable @Nullable String scriptLoaderStateJson, boolean useRelativePath)
      Get all script paths available for the currently authenticated user.
      Parameters:
      scriptLoaderStateJson - optional script loader state information
      useRelativePath - whether to return relative or display script paths
      Returns:
      the set of paths available for the current user

    • getScriptBody

      @FinalDefault @Nullable default @Nullable String getScriptBody(@NotNull @NotNull String scriptPath, boolean isPathRelative)
      Get the body of the specified script as the currently authenticated user.
      Parameters:
      scriptPath - the script path
      isPathRelative - if the scriptPath is a relative path
      Returns:
      the body of the script

    • getScriptBody

      @Nullable @Nullable String getScriptBody(@NotNull @NotNull String scriptPath, boolean isPathRelative, @Nullable @Nullable String scriptLoaderStateJson)
      Get the body of the specified script as the currently authenticated user.
      Parameters:
      scriptPath - the script path
      isPathRelative - if the scriptPath is a relative path
      scriptLoaderStateJson - optional script loader state information
      Returns:
      the body of the script

    • getScriptBodyByUser

      @FinalDefault @Nullable default @Nullable String getScriptBodyByUser(@NotNull @NotNull String scriptPath, @NotNull @NotNull String userName, boolean isPathRelative)
      Get the body of the specified script as the specified user.
      Parameters:
      scriptPath - the script path
      userName - the user to fetch the body as
      isPathRelative - if the scriptPath is relative
      Returns:
      the body of the script

    • getScriptBodyByUser

      @Nullable @Nullable String getScriptBodyByUser(@NotNull @NotNull String scriptPath, @NotNull @NotNull String userName, boolean isPathRelative, @Nullable @Nullable String scriptLoaderStateJson)
      Get the body of the specified script as the specified user.
      Parameters:
      scriptPath - the script path
      userName - the user to fetch the body as
      isPathRelative - if the scriptPath is relative
      scriptLoaderStateJson - optional script loader state information
      Returns:
      the body of the script

    • getScriptBodyByQuery

      @FinalDefault @Nullable default @Nullable String getScriptBodyByQuery(@NotNull @NotNull String scriptPath, long querySerial, boolean isPathRelative)
      Get a script by path for the owner of a specific query by serial.
      Parameters:
      querySerial - The Serial ID.
      scriptPath - The path string.
      isPathRelative - if the scriptPath is relative
      Returns:
      The contents of the script.

    • getScriptBodyByQuery

      @Nullable @Nullable String getScriptBodyByQuery(@NotNull @NotNull String scriptPath, long querySerial, boolean isPathRelative, @Nullable @Nullable String scriptLoaderStateJson)
      Get a script by path for the owner of a specific query by serial, with optional script loader state information.
      Parameters:
      querySerial - The Serial ID.
      scriptPath - The path string.
      isPathRelative - if the scriptPath is relative
      scriptLoaderStateJson - optional script loader state information
      Returns:
      The contents of the script.