Package com.inductiveautomation.ignition.gateway.system

Interface SystemManager

public interface SystemManager

  • Method Summary

    Modifier and Type
    Method
    Description
    File
    getBaseDir()
    Returns a File for the Ignition base directory.
    default Path
    getConfigDir()
    Returns a Path to `$data/config`.
    File
    getDataDir()
    Returns a File for the Ignition data directory.
    File
    getLibDir()
    Provides the path to the lib folder, which holds all the jars used by Ignition.
    File
    getLocalDir()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use SystemManager#getPlatformTransientDir() or SystemManager#getModuleTransientDir() for data that should not be added to a gwbk or synchronized to a redundant peer.
    File
    getLogsDir()
    Provides the path to the logs folder.
    default Path
    getModuleConfigDir(String moduleId)
    Returns a Path to `$data/config/{moduleId}`.
    default Path
    getModuleConfigLocalDir(String moduleId)
    Returns a Path to `$data/config/local/{module-id}`.
    default Path
    getModuleTransientDir(String moduleId)
    Returns a Path to `$data/var/{module-id}`.
    default Path
    getPlatformConfigDir()
    Returns a Path to `$data/config/ignition`.
    default Path
    getPlatformConfigLocalDir()
    Returns a path to `$data/config/local/ignition`.
    default Path
    getPlatformTransientDir()
    Returns a Path to `$data/var/ignition`.
    File
    getTempDir()
    Returns a temp dir that is managed by the context (cleaned out on startup.)
    File
    getUserLibDir()
    Provides the path to the userlib folder.

  • Method Details

    • getBaseDir

      File getBaseDir()
      Returns a File for the Ignition base directory.

      By default, this is the Ignition installation directory, but it's possible to alter the location of the base directory by configuration.

      Returns:
      a File object representing the base folder.

    • getDataDir

      File getDataDir()
      Returns a File for the Ignition data directory.

      By default, this is the `data` directory in the Ignition installation directory, but it's possible to alter the location of the data directory by configuration.

      Returns:
      a File object representing the data folder.

    • getLibDir

      File getLibDir()
      Provides the path to the lib folder, which holds all the jars used by Ignition. This value is always relative to the installation folder.
      Returns:
      a File object representing the lib folder.

    • getUserLibDir

      File getUserLibDir()
      Provides the path to the userlib folder. The userlib folder contains binaries that can be changed by the user. These binaries include the modules and the jdbc jars. The value is taken from the SystemProps.GATEWAY_LIB_DIRECTORY system property
      Returns:
      a File object representing the userlib folder.

    • getLogsDir

      File getLogsDir()
      Provides the path to the logs folder. The logs folder holds all the important log files used by Ignition. The value is taken from the SystemProps.GATEWAY_LOGS_DIRECTORY system property
      Returns:
      a File object representing the logs folder.

    • getTempDir

      File getTempDir()
      Returns a temp dir that is managed by the context (cleaned out on startup.)

    • getLocalDir

      @Deprecated(since="8.3.0", forRemoval=true) File getLocalDir()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use SystemManager#getPlatformTransientDir() or SystemManager#getModuleTransientDir() for data that should not be added to a gwbk or synchronized to a redundant peer. We will remove this method in a future version.
      Provides the path to the local folder. The local folder contains all internal database files for the local historian, audit log, and alarm journal. Excluded from gateway backups. The value is taken from the SystemProps.GATEWAY_LOCAL_DIRECTORY system property
      Returns:
      a File object representing the local folder.

    • getConfigDir

      default Path getConfigDir()
      Returns a Path to `$data/config`.

    • getPlatformConfigDir

      default Path getPlatformConfigDir()
      Returns a Path to `$data/config/ignition`.

      This folder is used to store configuration state or other data that doesn't neatly fit into the resource collection system. The contents of this folder will always be added to a .gwbk and the contents are eligible for redundancy synchronization (depending on the redundant provider implementation).

      This directory may not exist, and it is the responsibility of the caller to create it if necessary, e.g. with Files.createDirectories(Path, FileAttribute[]).

    • getPlatformConfigLocalDir

      default Path getPlatformConfigLocalDir()
      Returns a path to `$data/config/local/ignition`.

      This folder is used to store configuration state or other data for the module that doesn't neatly fit into the resource collection system, and is targeted to a specific machine. The contents of this folder will always be added to a .gwbk. In a redundant setup, the local folder is stored in a separate 'local-backup' folder if the local folder is retrieved from a redundant backup gateway. The contents are eligible for redundancy synchronization (depending on the redundant provider implementation).

      Note that while the local and local/backup folders will always be added to the gwbk, the user can choose whether or not to restore the folders when the gwbk is restored later. The user would want to restore the local files in a disaster recovery style scenario, where you need to get a specific machine back into a functional state. But you would not want to restore the local files if you were trying to move a gateway configuration from one system to another.

      This is a convenience method that is equivalent to calling getModuleConfigLocalDir(String) with "ignition" as the module id.

      This directory may not exist, and it is the responsibility of the caller to create it if necessary, e.g. with Files.createDirectories(Path, FileAttribute[]).

    • getPlatformTransientDir

      default Path getPlatformTransientDir()
      Returns a Path to `$data/var/ignition`.

      This is a transient folder and will not be collected in the gateway backup, nor synchronized to the redundant peer.

      This directory may not exist, and it is the responsibility of the caller to create it if necessary, e.g. with Files.createDirectories(Path, FileAttribute[]).

    • getModuleConfigDir

      default Path getModuleConfigDir(String moduleId)
      Returns a Path to `$data/config/{moduleId}`.

      This folder is used to store configuration state or other data for the module that doesn't neatly fit into the resource collection system. The contents of this folder will always be added to a .gwbk and the contents are eligible for redundancy synchronization (depending on the redundant provider implementation).

      This directory may not exist, and it is the responsibility of the caller to create it if necessary, e.g. with Files.createDirectories(Path, FileAttribute[]).

    • getModuleConfigLocalDir

      default Path getModuleConfigLocalDir(String moduleId)
      Returns a Path to `$data/config/local/{module-id}`.

      This folder is used to store configuration state or other data for a module that doesn't neatly fit into the resource collection system, and is targeted to a specific machine. The contents of this folder will always be added to a .gwbk. In a redundant setup, the local folder is stored in a separate 'local-backup' folder if the local folder is retrieved from a redundant backup gateway. The contents are eligible for redundancy synchronization (depending on the redundant provider implementation).

      Note that while the local and local/backup folders will always be added to the gwbk, the user can choose whether to restore the folders when the gwbk is restored later. The user would want to restore the local files in a disaster recovery style scenario, where you need to get a specific machine back into a functional state. But you would not want to restore the local files if you were trying to move a gateway configuration from one system to another.

      This directory may not exist, and it is the responsibility of the caller to create it if necessary, e.g. with Files.createDirectories(Path, FileAttribute[]).

    • getModuleTransientDir

      default Path getModuleTransientDir(String moduleId)
      Returns a Path to `$data/var/{module-id}`.

      This is a transient folder and will not be collected in the gateway backup, nor synchronized to the redundant peer.

      This directory may not exist, and it is the responsibility of the caller to create it if necessary, e.g. with Files.createDirectories(Path, FileAttribute[]).