Package com.inductiveautomation.ignition.gateway.system

Interface SystemManager

public interface SystemManager

  • Method Summary

    Modifier and Type
    Method
    Description
    File
    getDataDir()
    Returns the data directory for the system.
    File
    getEtcDir()
     
    File
    getLibDir()
    Provides the path to the lib folder, which holds all the jars used by Ignition.
    File
    getLocalDir()
    Provides the path to the local folder.
    File
    getLogsDir()
    Provides the path to the logs folder.
    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

    • getDataDir

      File getDataDir()
      Returns the data directory for the system. All created data will be contained in this folder.
      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 userlib.dir context parameter in webserver/webapps/main/WEB-INF/web.xml.
      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 logs.dir context parameter in webserver/webapps/main/WEB-INF/web.xml.
      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.)

    • getEtcDir

      File getEtcDir()

    • getLocalDir

      File getLocalDir()
      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 local.dir context parameter in webserver/webapps/main/WEB-INF/web.xml.
      Returns:
      a File object representing the local folder.