Package com.inductiveautomation.ignition.gateway.system

Interface SystemManager

  • public interface SystemManager

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.io.File getDataDir()
      Returns the data directory for the system.
      java.io.File getEtcDir()  
      java.io.File getLibDir()
      Provides the path to the lib folder, which holds all the jars used by Ignition.
      java.io.File getLocalDir()
      Provides the path to the local folder.
      java.io.File getLogsDir()
      Provides the path to the logs folder.
      java.io.File getTempDir()
      Returns a temp dir that is managed by the context (cleaned out on startup.)
      java.io.File getUserLibDir()
      Provides the path to the userlib folder.

    • Method Detail

      • getDataDir

        java.io.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

        java.io.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

        java.io.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

        java.io.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

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

      • getEtcDir

        java.io.File getEtcDir()

      • getLocalDir

        java.io.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.