Package com.illumon.iris.controller

Interface PersistentQueryScriptSource

All Superinterfaces:
RemoteScriptSource
All Known Implementing Classes:
PersistentQueryControllerClient
public interface PersistentQueryScriptSource extends RemoteScriptSource
A RemoteScriptSource that can load paths for a specific serial ID.

  • Method Details

    • getScriptDisplayPaths

      @FinalDefault @NotNull default Set<String> getScriptDisplayPaths(@Nullable ScriptPathLoaderState scriptLoaderState)
      Get all script paths available for the currently authenticated user.
      Parameters:
      scriptLoaderState - optional script loader state information
      Returns:
      the set of paths available for the current user

    • getScriptDisplayPaths

      @FinalDefault @NotNull default Set<String> getScriptDisplayPaths(@NotNull String ownerName, @Nullable ScriptPathLoaderState scriptLoaderState)
      Get the script paths available for the specified owner.
      Parameters:
      ownerName - the user to fetch paths for
      scriptLoaderState - optional script loader state information
      Returns:
      the set of paths available for the specified user

    • getScriptDisplayPaths

      @FinalDefault @NotNull default Set<String> getScriptDisplayPaths(long configSerial)
      Get all display paths available to a specific PersistentQuery serial ID.
      Parameters:
      configSerial - A serial ID.
      Returns:
      The paths available to the serial ID.

    • getScriptDisplayPaths

      @FinalDefault @NotNull default Set<String> getScriptDisplayPaths(long configSerial, @Nullable ScriptPathLoaderState scriptLoaderState)
      Get all display paths available to a specific PersistentQuery serial ID and a specific state.
      Parameters:
      configSerial - A serial ID.
      scriptLoaderState - A specific state to retrieve scripts from or ScriptPathLoaderState.NONE to get the latest version.
      Returns:
      The paths available to the serial ID.

    • getScriptDisplayPaths

      @NotNull Set<String> getScriptDisplayPaths(long configSerial, @Nullable String scriptLoaderState)
      Get all display paths available to a specific PersistentQuery serial ID and a specific state.
      Parameters:
      configSerial - the query serial
      scriptLoaderState - an optional loader state
      Returns:
      The paths available to the serial ID.

    • getScriptBody

      @FinalDefault @Nullable default String getScriptBody(boolean relative, @NotNull String scriptPath, long configSerial)
      Get a script by path for a specific serial ID.
      Parameters:
      relative - Is the path a relative path?
      scriptPath - The path string.
      configSerial - The Serial ID.
      Returns:
      The contents of the script.

    • getScriptBody

      @FinalDefault @Nullable default String getScriptBody(boolean relative, @NotNull String scriptPath, long configSerial, @Nullable ScriptPathLoaderState scriptLoaderState)
      Get a script by path for a specific serial ID and a specific state.
      Parameters:
      relative - Is the path a relative path?
      scriptPath - The path string.
      configSerial - The Serial ID.
      scriptLoaderState - an optional loader state.
      Returns:
      The contents of the script.

    • getScriptBody

      @Nullable String getScriptBody(boolean relative, long configSerial, @NotNull String scriptPath, @Nullable String scriptLoaderStateJson)
      Get a script by path for a specific serial ID and a specific state.
      Parameters:
      relative - Is the path a relative path?
      scriptPath - The path string.
      configSerial - The Serial ID.
      scriptLoaderStateJson - A specific state to retrieve scripts from or ScriptPathLoaderState.NONE to get the latest version.
      Returns:
      The contents of the script.

    • getScriptBody

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

    • getScriptBody

      @FinalDefault @Nullable default String getScriptBody(boolean relative, @NotNull String scriptPath, @NotNull String ownerName, @Nullable ScriptPathLoaderState scriptLoaderState)
      Get the body of the specified script as the specified user.
      Parameters:
      relative - if the scriptPath is relaztive
      scriptPath - the script path
      ownerName - the user to fetch the body as
      scriptLoaderState - optional script loader state information
      Returns:
      the body of the script