Package com.illumon.iris.controller

Interface RemoteScriptSource

All Known Subinterfaces:
PersistentQueryScriptSource
All Known Implementing Classes:
PersistentQueryControllerClient
public interface RemoteScriptSource
Describes a class that can retrieve script paths and bodies by a specific user.

  • Method Details

    • getScriptDisplayPaths

      default Set<String> getScriptDisplayPaths()
      Get all available display paths.
      Returns:
      All display paths.

    • getScriptDisplayPaths

      Set<String> getScriptDisplayPaths(@Nullable String scriptLoaderStateJson)
      Get all available display paths for a specific state.
      Parameters:
      scriptLoaderStateJson - The JSON encoded state produced by ScriptPathLoaderState.encodeJSON() to get paths from or null to get the latest version.
      Returns:
      All display paths.

    • getScriptDisplayPathsByOwner

      default Set<String> getScriptDisplayPathsByOwner(@NotNull String ownerName)
      Get all display paths available to a specific owner.
      Parameters:
      ownerName - A specific user.
      Returns:
      The paths available to ownerName.

    • getScriptDisplayPathsByOwner

      Set<String> getScriptDisplayPathsByOwner(@NotNull String ownerName, @Nullable String scriptLoaderStateJson)
      Get all display paths available to a specific owner and state.
      Parameters:
      ownerName - A specific user.
      scriptLoaderStateJson - The JSON encoded state produced by ScriptPathLoaderState.encodeJSON() to get paths from or null to get the latest version.
      Returns:
      The paths available to ownerName.

    • getScriptRelativePaths

      default Set<String> getScriptRelativePaths()
      Get all available relative paths.
      Returns:
      All relative paths.

    • getScriptRelativePaths

      Set<String> getScriptRelativePaths(@Nullable String scriptLoaderStateJson)
      Get all available relative paths for a specific state.
      Parameters:
      scriptLoaderStateJson - The JSON encoded state produced by ScriptPathLoaderState.encodeJSON() to get paths from or null to get the latest version.
      Returns:
      All relative paths.

    • getScriptRelativePathsByOwner

      default Set<String> getScriptRelativePathsByOwner(@NotNull String ownerName)
      Get all relative paths available to a specific owner.
      Parameters:
      ownerName - A specific user.
      Returns:
      The paths available to ownerName.

    • getScriptRelativePathsByOwner

      Set<String> getScriptRelativePathsByOwner(@NotNull String ownerName, @Nullable String scriptLoaderStateJson)
      Get all relative paths available to a specific owner and state.
      Parameters:
      ownerName - A specific user.
      scriptLoaderStateJson - The JSON encoded state produced by ScriptPathLoaderState.encodeJSON() to get paths from or null to get the latest version.
      Returns:
      The paths available to ownerName.

    • getScriptBody

      default String getScriptBody(boolean relative, @NotNull String scriptPath)
      Get a script by path.
      Parameters:
      relative - Is the path a relative path?
      scriptPath - The path string.
      Returns:
      The contents of the script.

    • getScriptBody

      String getScriptBody(boolean relative, String scriptPath, String scriptLoaderStateJson)
      Get a script by path and state.
      Parameters:
      relative - Is the path a relative path?
      scriptPath - The path string.
      scriptLoaderStateJson - The JSON encoded state produced by ScriptPathLoaderState.encodeJSON() to get the script from or null to get the latest version.
      Returns:
      The contents of the script.

    • getScriptBodyByOwner

      default String getScriptBodyByOwner(boolean relative, @NotNull String scriptPath, @NotNull String ownerName)
      Get a script by path for a specific owner.
      Parameters:
      relative - Is the path a relative path?
      scriptPath - The path string.
      ownerName - The owner.
      Returns:
      The contents of the script.

    • getScriptBodyByOwner

      String getScriptBodyByOwner(boolean relative, @NotNull String scriptPath, @NotNull String ownerName, @Nullable String scriptLoaderStateJson)
      Get a script by path for a specific owner and state.
      Parameters:
      relative - Is the path a relative path?
      scriptPath - The path string.
      ownerName - The owner.
      scriptLoaderStateJson - The JSON encoded state produced by ScriptPathLoaderState.encodeJSON() to get script from or null to get the latest version.
      Returns:
      The contents of the script.