Interface ExportConfiguration

All Known Implementing Classes:
DefaultExportConfiguration

public interface ExportConfiguration
Configuration class that holds the relevant settings for exporting documents
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Returns the amount of downloads that can take place before the export-file is removed
    int
    Returns the interval (in minutes) that defines how often the cleanup scheduler will run.
    int
    Returns the time (in minutes) that defines how long an export-temp-file will be kept before the cleanup scheduler will remove it
    Returns the path, where export temp files will be stored. defaults to java.io.tempdir
    void
    setMaxDownloadCount(int maxDownloadCount)
    Sets the amount of downloads that can take place before the export-file is removed
    void
    setTempFileCleanupInterval(int tempFileCleanupInterval)
    Sets the interval (in minutes) that defines how often the cleanup scheduler will run.
    void
    setTempFileMaxAge(int tempFileMaxAge)
    sets the time (in minutes) that defines how long an export-temp-file will be kept before the cleanup scheduler will remove it
    void
    setTempFolderPath(String tempFolderPath)
    Sets the path, where export temp files will be stored.
  • Method Details

    • getMaxDownloadCount

      int getMaxDownloadCount()
      Returns the amount of downloads that can take place before the export-file is removed
      Returns:
      the amount of downloads that can take place before the export-file is removed
    • setMaxDownloadCount

      void setMaxDownloadCount(int maxDownloadCount)
      Sets the amount of downloads that can take place before the export-file is removed
      Parameters:
      maxDownloadCount - the amount of downloads that can take place before the export-file is removed
    • getTempFileCleanupInterval

      int getTempFileCleanupInterval()
      Returns the interval (in minutes) that defines how often the cleanup scheduler will run.
      Returns:
      the interval (in minutes) that defines how often the cleanup scheduler will run
    • setTempFileCleanupInterval

      void setTempFileCleanupInterval(int tempFileCleanupInterval)
      Sets the interval (in minutes) that defines how often the cleanup scheduler will run.
      Parameters:
      tempFileCleanupInterval - the interval (in minutes) that defines how often the cleanup scheduler will run
    • getTempFolderPath

      String getTempFolderPath()
      Returns the path, where export temp files will be stored. defaults to java.io.tempdir
      Returns:
      Customize Toolbar…
    • setTempFolderPath

      void setTempFolderPath(String tempFolderPath)
      Sets the path, where export temp files will be stored.
      Parameters:
      tempFolderPath - the path, where export temp files will be stored
    • getTempFileMaxAge

      int getTempFileMaxAge()
      Returns the time (in minutes) that defines how long an export-temp-file will be kept before the cleanup scheduler will remove it
      Returns:
      the time (in minutes) that defines how long an export-temp-file will be kept before the cleanup scheduler will remove it
    • setTempFileMaxAge

      void setTempFileMaxAge(int tempFileMaxAge)
      sets the time (in minutes) that defines how long an export-temp-file will be kept before the cleanup scheduler will remove it
      Parameters:
      tempFileMaxAge - the time (in minutes) that defines how long an export-temp-file will be kept before * the cleanup scheduler will remove it