Package de.espirit.firstspirit.server.configuration

Class ServerProperties

java.lang.Object
de.espirit.firstspirit.server.configuration.ServerProperties
public class ServerProperties extends Object
A list of all accessible server properties. Use ServerConfigurationAgent.getServerProperty(ServerProperty) for retrieving the current value in a type safe way.
Since:
5.2.180704

  • Field Details

    • ADMIN_MAIL_ADDRESS

      public static final ServerProperty<String> ADMIN_MAIL_ADDRESS
      Administrator's email address used to send notification mails to.
      Since:
      5.2.180704

    • AJAX_DATA_SYNC_TIMEOUT

      public static final ServerProperty<Duration> AJAX_DATA_SYNC_TIMEOUT
      Data sync timeout for AJAX in Webmonitor
      Since:
      5.2.180704

    • AJAX_IMAGE_RELOAD_TIMEOUT

      public static final ServerProperty<Duration> AJAX_IMAGE_RELOAD_TIMEOUT
      Image reload timeout in Webmonitor
      Since:
      5.2.180704

    • HDD_WARN_LIMIT

      @Deprecated public static final ServerProperty<Integer> HDD_WARN_LIMIT
      Deprecated.
      since 5.2.230209 - replaced by FREE_SPACE_WARN_LIMIT.
      Percental limit of hard disk drive space left. A warning e-mail is issued if this limit is exceeded.
      Since:
      5.2.180704
      See Also:

    • FREE_SPACE_WARN_LIMIT

      public static final ServerProperty<String> FREE_SPACE_WARN_LIMIT
      Server minimum free space warning limit. If the free space left on the server falls below the limit, a warning mail is issued.
      The value is in one of the supported limit formats:
      • Relative percent values. A warning mail is send if the used space exceeds the configured value: 90%
      • Absolute size values. A warning mail is send if the free space falls below the configured value: 75000k, 1500m, 3g
      Since:
      5.2.230209
      See Also:

    • HDD_WARN_LIMIT_ACTIVE

      public static final ServerProperty<Boolean> HDD_WARN_LIMIT_ACTIVE
      Indicates whether or not a warning mail will be issued if space left limit is exceeded.
      Since:
      5.2.180704
      See Also:

    • HDD_SHUTDOWN_LIMIT

      @Deprecated public static final ServerProperty<Integer> HDD_SHUTDOWN_LIMIT
      Deprecated.
      since 5.2.230209 - replaced by FREE_SPACE_SHUTDOWN_LIMIT.
      Percental limit of hard disk drive space left. The server will be shut down automatically if this limit is exceeded.
      Since:
      5.2.180704
      See Also:

    • FREE_SPACE_SHUTDOWN_LIMIT

      public static final ServerProperty<String> FREE_SPACE_SHUTDOWN_LIMIT
      Server minimum free space shutdown limit. If the free space left on the server falls below the limit, the server will shut down.
      The value is in one of the supported limit formats:
      • Relative percent values. The server will shutdown if the used space exceeds the configured value: 90%
      • Absolute size values. The server will shutdown if the free space falls below the configured value: 75000k, 1500m, 3g
      Since:
      5.2.230209
      See Also:

    • HDD_SHUTDOWN_LIMIT_ACTIVE

      public static final ServerProperty<Boolean> HDD_SHUTDOWN_LIMIT_ACTIVE
      Indicates whether or not the server will be shut down if space left limit is exceeded.
      Since:
      5.2.180704
      See Also:

    • HDD_DIRECTORIES

      public static final ServerProperty<String> HDD_DIRECTORIES
      Directories used for disk space check (comma separated)
      Since:
      5.2.180704
      See Also:

    • MEMORY_LIMIT

      @Deprecated(forRemoval=true, since="5.2.250308") public static final ServerProperty<Integer> MEMORY_LIMIT
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.2.250308 - no replacement
      Maximum percentage of memory to be used
      Since:
      5.2.180704

    • STATISTIC_START

      public static final ServerProperty<LocalTime> STATISTIC_START
      Full hour at which statistics data is gathered on a daily basis.
      Since:
      5.2.180704

    • MEMORY_WARN_ACTIVE

      @Deprecated(forRemoval=true, since="5.2.250308") public static final ServerProperty<Boolean> MEMORY_WARN_ACTIVE
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.2.250308 - no replacement
      Indicates if the memory warning is enabled.
      If enabled a notification email will be sent to the configured email address.
      Since:
      5.2.180704

    • OUT_OF_MEMORY_WARN_ACTIVE

      @Deprecated(forRemoval=true, since="5.2.250308") public static final ServerProperty<Boolean> OUT_OF_MEMORY_WARN_ACTIVE
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.2.250308 - no replacement
      Indicates if the out of memory warning for the FirstSpirit server is enabled.
      Since:
      5.2.180704

    • MESSAGE_OF_THE_DAY_VISIBLE

      public static final ServerProperty<Boolean> MESSAGE_OF_THE_DAY_VISIBLE
      Indicates if the Message of the Day is to be shown.
      Since:
      5.2.180704

    • SOCKET_PORT

      public static final ServerProperty<Integer> SOCKET_PORT
      Socket port of the FirstSpirit server.
      Since:
      5.2.180704

    • HTTP_PORT

      public static final ServerProperty<Integer> HTTP_PORT
      HTTP port of the FirstSpirit server.
      Since:
      5.2.180704

    • WEBAPP_ROOT_URL

      public static final ServerProperty<String> WEBAPP_ROOT_URL
      Path of the root web application, for an internal servlet engine this is typically "/" and "/fs5root" for external servlet engines (e.g. Tomcat).
      Since:
      5.2.180704

    • HOST

      public static final ServerProperty<String> HOST
      Configured host name of the FirstSpirit server.
      Since:
      5.2.180704

    • URL

      public static final ServerProperty<URL> URL
      URL of the FirstSpirit server
      Since:
      5.2.180704

    • CLUSTER_SLAVE_NAME

      public static final ServerProperty<String> CLUSTER_SLAVE_NAME
      Name of the slave cluster server
      Since:
      5.2.180704

    • CLUSTER_SERVER_PATH

      public static final ServerProperty<Path> CLUSTER_SERVER_PATH
      Path to the master cluster server
      Since:
      5.2.180704

    • CLUSTER_MASTER_HOST

      public static final ServerProperty<String> CLUSTER_MASTER_HOST
      Host name of the master cluster server
      Since:
      5.2.180704

    • CLUSTER_MASTER_PORT

      public static final ServerProperty<Integer> CLUSTER_MASTER_PORT
      Port of the master cluster server
      Since:
      5.2.180704

    • BACKUP_MAIL

      public static final ServerProperty<String> BACKUP_MAIL
      E-mail address for backup information
      Since:
      5.2.180704

    • LAUNCHER_JRE_MACOS_PATH

      public static final ServerProperty<Path> LAUNCHER_JRE_MACOS_PATH
      Path to the launcher JRE used on macOS.
      Since:
      5.2.231213

    • LAUNCHER_JRE_WINDOWS_PATH

      public static final ServerProperty<Path> LAUNCHER_JRE_WINDOWS_PATH
      Path to the launcher JRE used on Windows.
      Since:
      5.2.231213

  • Constructor Details

    • ServerProperties

      public ServerProperties()