Package de.xima.fc

Class PathHandler.FS

java.lang.Object
de.xima.fc.PathHandler.FS
Enclosing class:
PathHandler

public static final class PathHandler.FS extends Object
Zentrale Behandlung von Pfaden im lokalen FileSystem
  • Method Details

    • getPluginBaseDir

      public static Path getPluginBaseDir()
    • getPluginBaseDirPath

      public static String getPluginBaseDirPath()
    • getPluginDirPath

      public static String getPluginDirPath(String scopeKey)
    • getPluginDirPath

      public static String getPluginDirPath(String scopeKey, String runtimeKey)
    • getDataDirFile

      public static File getDataDirFile()
    • getDataDirPath

      public static Path getDataDirPath()
    • getDataDir

      public static String getDataDir()
    • getMalwareScanDir

      public static Path getMalwareScanDir()
      Returns:
      The directory where files should be placed that may potentially contain malware. These files should be scanned by a IMalwareScanner before they are used.
    • getMalwareScanDir

      public static Path getMalwareScanDir(boolean create) throws IOException
      Parameters:
      create - If true, ensures the directory exists and creates it if not.
      Returns:
      The directory where files should be placed that may potentially contain malware. These files should be scanned by a IMalwareScanner before they are used.
      Throws:
      IOException - When the directory does not exist and could not be created.
    • getTempFolder

      public static File getTempFolder() throws IOException
      Throws:
      IOException
    • getTempDir

      public static String getTempDir()
    • getTempPath

      public static Path getTempPath()
    • getTempFolder

      public static File getTempFolder(boolean createIfMissing) throws IOException
      Throws:
      IOException
    • getVorgangsWorkflowDirPath

      public static String getVorgangsWorkflowDirPath(Vorgang v)
      Liefert den Pfad zum temporären Verzeichnis für die Verarbeitung des übergebenen Vorgangs.
    • getCacheDirPath

      public static Path getCacheDirPath()
    • getCacheDir

      public static String getCacheDir()
    • getCacheDirPath

      @Deprecated public static String getCacheDirPath(String cacheName)
      Deprecated.
    • getCacheDirPath

      public static <E extends IFileDataEntity<?>, T extends IFileProviding<?, E>> String getCacheDirPath(T entity)
    • getAktionWorkflowDirPath

      public static String getAktionWorkflowDirPath(Vorgang v, Aktion a)
      Liefert den Pfad zum temporären Verzeichnis für die Verarbeitung der übergebenen Aktion innerhalb des übergebenen Vorgangs.
    • getNodeWorkflowDirPath

      public static String getNodeWorkflowDirPath(Vorgang formRecord, WorkflowNode node)
    • getSharedWorkflowDirPath

      public static String getSharedWorkflowDirPath(Vorgang formRecord)
    • getAktionWorkflowDirPath

      public static String getAktionWorkflowDirPath(Vorgang v, Aktion a, String postfix)
    • getNodeWorkflowDirPath

      public static String getNodeWorkflowDirPath(Vorgang formRecord, WorkflowNode node, String postfix)
    • getSharedWorkflowDirPath

      public static String getSharedWorkflowDirPath(Vorgang formRecord, String postfix)
    • setConfigDir

      public static void setConfigDir(File configDir)
    • setTempDir

      public static void setTempDir(String customTempDir)
    • setCacheDir

      public static void setCacheDir(Path cacheDir)
      Sets a custom directory where cache files are stored.
      Parameters:
      cacheDir - The custom cache directory.
    • getKerberosLoginConfigFile

      public static File getKerberosLoginConfigFile()
    • getKerberosKRB5ConfigFile

      public static File getKerberosKRB5ConfigFile()
    • getConfigDir

      public static File getConfigDir()
    • getConfigDirPath

      public static Path getConfigDirPath()
    • getLicenseFile

      @Deprecated public static File getLicenseFile()
      Deprecated.
    • setDataDir

      public static void setDataDir(String configuredDataDir)
      Sets a custom directory where applicatio specific data is stored.
      Parameters:
      configuredDataDir - The custom data directory.
    • setPluginDir

      public static void setPluginDir(Path pluginDir)
      Sets a custom directory where plugin files are stored, such as JAR files and properties file.
      Parameters:
      pluginDir - The custom plugin directory.
    • getMandantBaseDirPath

      @Deprecated public static String getMandantBaseDirPath(Mandant m)
      Deprecated.
      Liefert das mandantenspezifische Verzeichnis (nutzerdefiniert oder Standardwert), das für die Speicherung von Dateien verwendet werden kann.
    • getMandantPluginDirPath

      @Deprecated public static String getMandantPluginDirPath(Mandant mandant) throws IOException
      Deprecated.
      Throws:
      IOException
    • getSystemPluginDirPath

      @Deprecated public static String getSystemPluginDirPath() throws IOException
      Deprecated.
      Throws:
      IOException
    • getBackupDir

      @Deprecated public static File getBackupDir()
      Deprecated.
      Liefert den Pfad zum Backup-Verzeichnis alter FormCycle-Versionen (Wird nur noch für Übergangszeitraum benötigt)
      Returns:
      File the backup-dir
    • getVorgangsAttachmentDirPath

      @Deprecated public static String getVorgangsAttachmentDirPath(Vorgang v) throws IOException
      Deprecated.
      Liefert den Pfad zum Verzeichnis für die Vorgangsdaten (Attachments).
      Throws:
      IOException
    • setMalwareScanDir

      public static void setMalwareScanDir(Path scanDir)
      Parameters:
      scanDir - The directory where files should be placed that may potentially contain malware. These files should be scanned by a IMalwareScanner before they are used.