Class ServerSettings

Method Details

• addPredefinedProps

  protected void addPredefinedProps() throws PropException

  Adds the predefined containers for identifications, fields and actions. This method is overridden fully by the Editor versions of the class.

  Overrides:

  addPredefinedProps in class PropCnr

  Throws:

  PropException - for property exceptions.

• clone

  public ServerSettings clone()

  Creates a clone out of this property. The cloning is overridden by the subclasses in order to handle cloning of its class variables appropriately.

  Overrides:

  clone in class PropCnr

• getSecretsContext

  public String getSecretsContext()

  Gets the secrets context of this server configuration: the value of SECRETS_CONTEXT.

  Specified by:

  getSecretsContext in interface ISecretsContext

  Returns:

  The context, or null when it is not set or not a valid context name (logged SEVERE once): no secret of this configuration is then resolved or stored.

• proposeSecretsContext

  public String proposeSecretsContext(String project, String fileBaseName)

  Proposes the secrets context of this configuration at its first secret-marked member, as server.<project>.<file base name> (decision P-4 (a)): only when the configuration marks a member secret and has no SECRETS_CONTEXT yet. The Designer calls it before it saves the file, so that the context is written with the first mark; it is an ordinary member afterwards. A server never proposes one: a production configuration carries the name its store was filled under (decision SK3-D-5).

  Parameters:

  project - The project name, null or empty for none.

  fileBaseName - The file name without its extension, e.g. "config".

  Returns:

  The context set, or null when none was needed.

• onPropTreeInitialized

  public void onPropTreeInitialized() throws IOException, PropException

  Called when the tree of the configuration file is complete: gives every secret-marked member its value from this machine's secrets store, under this configuration's context (CC-SECRETS-SK3-CONTEXTS, design section 5). A missing value is logged once per key - SEVERE on a production server - and leaves the member unconfigured; the server starts (P-15).

  Specified by:

  onPropTreeInitialized in interface IGProp<GProp<?>[]>

  Overrides:

  onPropTreeInitialized in class PropCnr

  Throws:

  IOException - For file errors of the children.

  PropException - For initialization problems of the children.

• getDescription

  public String getDescription()

  Gets the description of the Server.

  Specified by:

  getDescription in interface IServerSettings

  Returns:

  The description, "iiziServer" for default.

• setDescription

  public boolean setDescription(String descr)

  Sets the description of the server.

  Parameters:

  descr - New server description, non-null.

  Returns:

  true for changes, false for no change.

  Throws:

  NullPointerException - if descr is null.

• getLogFileName

  public String getLogFileName()

  Gets the log file name.

  Returns:

  The log file name, default "logs/server.log".

• getMaximumLogFileSize

  public long getMaximumLogFileSize()

  Gets the maximum log file size.

  Returns:

  The maximum log file size, zero for no maximum.

• getLogLevel

  public int getLogLevel()

  Gets the log level to use.

  Returns:

  The log level as defined in ILog, range is ILog.SEVERE to ILog.FINEST.

• getLogToConsole

  public boolean getLogToConsole()

  Logging output also to console.

  Returns:

  true to write log to console as well as to log file, default true.

• getLogHistorySize

  public int getLogHistorySize()

  Gets the history size for events kept in-memory for the server administration program to retrieve.

  Returns:

  The number of events, minimum 100, maximum 5000, default 500.

• getAdministratorPasswordPolicy

  public PasswordPolicy getAdministratorPasswordPolicy()

  Gets the password policy for administrators.

  Returns:

  The password policy settings for administrators.

• getSignInModuleID

  public String getSignInModuleID()

  Gets the application ID of the SignIn module, the only code that may use IUserAuthenticationUI.

  Returns:

  The module application ID, DEFAULT_SIGNIN_MODULE when not configured.

• isSelfSignUpEnabled

  public boolean isSelfSignUpEnabled()

  Checks if self sign-up with the internal login provider is enabled.

  Returns:

  The flag, false by default.

• isStaySignedInEnabled

  public boolean isStaySignedInEnabled()

  Checks if a user may stay signed in on a device.

  Returns:

  The flag, true by default.

• getStaySignedInDays

  public int getStaySignedInDays()

  Gets the days a device stays signed in, and is remembered, from its last use.

  Returns:

  The days, 30 by default; a value out of range is the nearest limit.

• getTrustDeviceDays

  public int getTrustDeviceDays()

  Gets the days a device is trusted for MFA when the user asks for it.

  Returns:

  The days, 30 by default, 0 for no trust; a value out of range is the nearest limit.

• getUserPasswordPolicy

  public PasswordPolicy getUserPasswordPolicy()

  Gets the password policy for users.

  Returns:

  The password policy settings for normal users.

• createPolicyProps

  protected PolicyProps createPolicyProps(Atom atom)

  Creates a policy property with the specified atom name.

  Parameters:

  atom - The atom name.

  Returns:

  The policy property.

• getWSRedirectCodeHTTP_to_HTTPS

  public int getWSRedirectCodeHTTP_to_HTTPS()

  The return code to use when web server receives HTTP requests to redirect to HTTPS. Can be 0 = no redirection, 301 = moved permanently, 302 = moved temporarily (default).

  Specified by:

  getWSRedirectCodeHTTP_to_HTTPS in interface IServerSettings

  Returns:

  A return code of 0, 301 or 302.

• setExternalHostName

  public boolean setExternalHostName(String extServerURL)

  Sets the external server URL, including protocol and potential port number (if different from protocol port).

  This setting must be set if the retrieval of the local host name e.g. does not include the domain DNS suffix, or that the name is known on external nets differently than on the internal network. This host name is typically used for the OAuth 2.0 authentication callback URL's.

  Parameters:

  extServerURL - The URL to use.

  Returns:

  true when this property container has been changed, false otherwise (or for error).

  Throws:

  NullPointerException - If extHostName is null.

  IllegalArgumentException - If extHostName is empty or not valid.

• getExternalHostName

  public String getExternalHostName()

  Gets the external server URL, including protocol and potential port number (if different from protocol port).

  This setting must be set if the retrieval of the local host name e.g. does not include the domain DNS suffix, or that the name is known on external nets differently than on the internal network. This host name is typically used for the OAuth 2.0 authentication callback URL's.

  Returns:

  The URL, or null for none.

• getAllowedOrigins

  public String getAllowedOrigins()

  Gets the origins allowed to call this server cross-origin and to open a WebSocket, as written in the $allowedOrigins setting; HubOrigins parses the list (CC-FIX-SB-CORS).

  Returns:

  The setting as written, or null for none or blank.

• setRootDirectory

  public boolean setRootDirectory(String root) throws IOException

  Sets the root directory for external files. This call is done from a server instance when e.g. the command line overrides the default root in the settings.

  Parameters:

  root - The new root.

  Returns:

  true when this property container has been changed, false otherwise (or for error).

  Throws:

  IOException - If the directory does not exist.

• getRootDirectory

  public String getRootDirectory()

  Gets the root directory for external files. If the directory doesn't exist it will be created.

  Specified by:

  getRootDirectory in interface IServerSettings

  Returns:

  The root directory or "./root" if none is specified. The return String is null if the directory cannot be created if not present, or the root is not a readable and writable directory. At the same time, logging will occur.

• getWSLogDirectory

  public String getWSLogDirectory() throws IOException

  Gets the logger directory for web server log files. If the directory doesn't exist it will be created.

  Specified by:

  getWSLogDirectory in interface IServerSettings

  Returns:

  The root directory or "./logs/web" if none is specified. If the return code is null it is assumed no logging will be performed.

  Throws:

  IOException - In case the web server log directory is not valid or cannot be created.

• getWSLogsRetainDays

  public int getWSLogsRetainDays()

  Gets the number of days to retain web server log files.

  Specified by:

  getWSLogsRetainDays in interface IServerSettings

  Returns:

  The default is 14, set to zero to disable logging.

• getWSLogTimeZone

  public String getWSLogTimeZone()

  Gets the time zone ID for logging web server requests.

  Specified by:

  getWSLogTimeZone in interface IServerSettings

  Returns:

  The Time Zone ID, or GMT (default).

• isDirectoryListingAllowed

  public boolean isDirectoryListingAllowed()

  Flag for directory listing allowed.

  Specified by:

  isDirectoryListingAllowed in interface IServerSettings

  Returns:

  The flag allowing directory listing of the web servers root and subdirectories, default false.

• useGzip

  public boolean useGzip()

  Flag if Gzip compression should be used in the web server.

  Specified by:

  useGzip in interface IServerSettings

  Returns:

  true to enable Gzip (default), false otherwise.

• getWSMaxThreads

  public int getWSMaxThreads()

  Get the web server maximum number of threads, default is 200. Range is 20 to 1024, always larger or equal to the minimum threads. An out-of-range value will give the default.

  Specified by:

  getWSMaxThreads in interface IServerSettings

  Returns:

  The maximum number of threads.

• getWSMinThreads

  public int getWSMinThreads()

  Get the web server minimum number of threads, default is 8. Range is 20 to 1024, always smaller or equal to the minimum threads. An out-of-range value will give the default.

  Specified by:

  getWSMinThreads in interface IServerSettings

  Returns:

  Minimum number of threads.

• getWSReservedThreads

  public int getWSReservedThreads()

  Get the web server number of reserved threads, default to -1. Range is 8-64, or -1 for heuristically determined. An out-of-range value will give the default -1.

  Specified by:

  getWSReservedThreads in interface IServerSettings

  Returns:

  Number of reserved threads or -1 for heuristically determined.

• getWSIdleTimeout

  public int getWSIdleTimeout()

  Get the web server maximum thread idle time, default is 60 seconds, 60_000 milliseconds. Range is 5_000 (5 seconds) to 300_000 (5 minutes). An out-of-range value will give the default.

  Specified by:

  getWSIdleTimeout in interface IServerSettings

  Returns:

  Max idle time in ms.

• getFileProviderRoot

  public String getFileProviderRoot()

  Gets the root directory relative the server's current directory where to place external files provided for remote usage over the web server.

  Returns:

  The root directory name, relative (or absolute path), "wsfiles" as default.

• getRealmPropertiesFileName

  public String getRealmPropertiesFileName()

  Gets the file name for the authentication realm properties.

  Specified by:

  getRealmPropertiesFileName in interface IServerSettings

  Returns:

  The file name, or "authentication-realm-properties.txt" if undefined.

• getAuthenticationRealm

  public String getAuthenticationRealm()

  Gets the realm for authentication.

  Specified by:

  getAuthenticationRealm in interface IServerSettings

  Returns:

  The realm string, "iiziServer Authentication" if not defined or empty String.

• isBasicAuthenticationEnabled

  public boolean isBasicAuthenticationEnabled()

  Checks if basic authentication should be used.

  Specified by:

  isBasicAuthenticationEnabled in interface IServerSettings

  Returns:

  The flag for authentication enabled.

• getUrlboxIOAPIKey

  public String getUrlboxIOAPIKey()

  Gets the "urlbox.io" API key.

  You will find this key on your Dashboard when you login to "urlbox.io".

  Returns:

  The configured API key, empty string for none.

• getMaxConcurrentThumbnailsRequests

  public int getMaxConcurrentThumbnailsRequests()

  The maximum count of current thumbnail requests to "urlbox.io", default 5.

  Be careful not to exceed your quota, there are different plans available.

• isFileUploadEnabled

  public boolean isFileUploadEnabled()

  Checks if file upload is enabled or not.

  Returns:

  The upload enablement flag, false by default.

• getMaximumUploadFileSize

  public int getMaximumUploadFileSize()

  Returns the maximum size of any uploaded file in MB.

  Returns:

  The file size in MB, default 50 MB.

• getFileUploadStagingDirectory

  public String getFileUploadStagingDirectory()

  Gets the upload directory where files are placed in a staging area.

  Returns:

  The directory name, relative the server's current directory.

• getUploadServerQuotaMB

  public int getUploadServerQuotaMB()

  Gets the server-global upload quota.

  Returns:

  The quota in MB, 0 for unlimited, default 10240 MB.

• getUploadSessionQuotaMB

  public int getUploadSessionQuotaMB()

  Gets the per-application-session upload quota.

  Returns:

  The quota in MB, 0 for unlimited, default 1024 MB.

• getUploadMaxFiles

  public int getUploadMaxFiles()

  Gets the maximum file count per upload reservation.

  Returns:

  A value between 1 and 10000, default 1000.

• getUploadChunkSizeKB

  public int getUploadChunkSizeKB()

  Gets the upload chunk size.

  Returns:

  A value between 64 and 8192 KB, default 2048 KB.

• getUploadIdleTimeout

  public int getUploadIdleTimeout()

  Gets the upload idle timeout.

  Returns:

  A value between 60 and 86400 seconds, default 1800.

• getUploadStartTimeout

  public int getUploadStartTimeout()

  Gets the upload start timeout.

  Returns:

  A value between 10 and 600 seconds, default 60.

• getUploadMaxPause

  public int getUploadMaxPause()

  Gets the upload maximum pause time.

  Returns:

  A value between 60 and 86400 seconds, default 3600.

• getUploadPermittedTypes

  public String getUploadPermittedTypes()

  Gets the permitted upload media types.

  Returns:

  The comma-separated list, empty for any (the default).

• getMaximumGeolocationHistorySizePerUser

  public int getMaximumGeolocationHistorySizePerUser()

  Gets the maximum number of geolocation entries per user in the history.

  Returns:

  The maximum number of locations, default 100, minimum 10, maximum 10000.

• isGeoSessionLogEnabled

  public boolean isGeoSessionLogEnabled()

  Checks if the geolocation of client sessions is logged at connect, reconnect and disconnect.

  Returns:

  The flag, default false.

• isGeoWebProvidersEnabled

  public boolean isGeoWebProvidersEnabled()

  Checks if the web region location providers (GeoPlugin, IPStack, IPWhoIs) are registered in production.

  Returns:

  The flag, default false.

• getGeoTrustedProxies

  public String getGeoTrustedProxies()

  Gets the trusted proxies list whose forwarded headers name the real client address.

  Returns:

  The comma-separated list of IP addresses and CIDR prefixes, empty string for none.

• isIP2LocationEnabled

  public boolean isIP2LocationEnabled()

  Checks if the local IP2Location database service is enabled.

  Returns:

  The flag, default false.

• getIP2LocationToken

  public String getIP2LocationToken()

  Gets the IP2Location LITE download token.

  Returns:

  The configured token trimmed, empty string for none.

• getIP2LocationDatabasePath

  public String getIP2LocationDatabasePath()

  Gets the IP2Location database directory.

  Returns:

  The directory, relative the server's current directory or absolute, default "IP2Location".

• getIP2LocationDatabase

  public Database getIP2LocationDatabase()

  Gets the IP2Location LITE database tier.

  Returns:

  The database, Database.DB11_LITE by default and for an unknown name.

• isIP2LocationIPv6Enabled

  public boolean isIP2LocationIPv6Enabled()

  Checks if the IPv6 database is downloaded and loaded as well.

  Returns:

  The flag, default false.

• isIP2LocationMemoryMapped

  public boolean isIP2LocationMemoryMapped()

  Checks if the databases are accessed as memory-mapped files.

  Returns:

  The flag, default true.

• getIP2LocationRecoveryAction

  public RecoveryConfig.RecoveryAction getIP2LocationRecoveryAction()

  Gets the recovery action when error thresholds are exceeded.

  Returns:

  The action, RecoveryConfig.RecoveryAction.NOTIFY_ONLY by default and for an unknown name.

• getIP2LocationInitFailureThreshold

  public int getIP2LocationInitFailureThreshold()

  Gets the consecutive initialization failures before recovery.

  Returns:

  A value between 1 and 100, default 2.

• getIP2LocationLookupErrorThreshold

  public int getIP2LocationLookupErrorThreshold()

  Gets the consecutive lookup errors before recovery.

  Returns:

  A value between 1 and 1000, default 10.

• getIP2LocationMaxAutoRecoveryAttempts

  public int getIP2LocationMaxAutoRecoveryAttempts()

  Gets the maximum automatic recovery attempts.

  Returns:

  A value between 1 and 10, default 3.

• getIP2LocationRecoveryCooldownMinutes

  public int getIP2LocationRecoveryCooldownMinutes()

  Gets the cooldown in minutes between recovery attempts.

  Returns:

  A value between 5 and 1440, default 60.

• isIP2LocationRecoverOnDownloadFailure

  public boolean isIP2LocationRecoverOnDownloadFailure()

  Checks if recovery is attempted after a download failure.

  Returns:

  The flag, default false.

• isIP2LocationRecoverOnCorruption

  public boolean isIP2LocationRecoverOnCorruption()

  Checks if recovery is attempted on database corruption.

  Returns:

  The flag, default true.

• isIP2LocationNotifyOnTransientErrors

  public boolean isIP2LocationNotifyOnTransientErrors()

  Checks if listeners are notified on transient errors.

  Returns:

  The flag, default false.

• getWebEngineGraceDays

  public int getWebEngineGraceDays()

  Gets the grace period before a client whose web engine has a newer version is called behind.

  Returns:

  The days, default 30, minimum 0, maximum 365.

• getWebEngineDataFile

  public String getWebEngineDataFile()

  Gets the web engine support table file that replaces the bundled one.

  Returns:

  The file name, relative the server's current directory or absolute, empty string for the bundled table (the default).

• isWebEngineRefreshEnabled

  public boolean isWebEngineRefreshEnabled()

  Checks if the first-stable days of the Chrome majors are refreshed online.

  Returns:

  The flag, default true.

• getClientIdleTimeout

  public long getClientIdleTimeout()

  Gets the timeout before a client session is disposed when it has not processes any transactions, default 2 hours. Range is 2 minutes to 2 days; a configured value outside it is clamped. The idle timeout includes dormant session timeout.

  Returns:

  Value in milliseconds, between 120_000L and 172_800_000L.

• getClientDormantTimeout

  public long getClientDormantTimeout()

  Timeout before an app session is disposed of when no more client sessions are present, default 10 minutes. Range is 2 minutes to 12 hours; a configured value outside it is clamped.

  Returns:

  Value in milliseconds, between 120_000L and 43_200_000L.

• getClientHeartBeatInterval

  public long getClientHeartBeatInterval()

  Heartbeat interval to keep the communication link up, default 45 seconds. Range is 30 seconds to 5 minutes, the one range SessionMgr defines and SessionMgr.setup accepts; a configured value outside it is clamped.

  Returns:

  Value in milliseconds, between SessionMgr.MIN_HEARTBEAT_INTERVAL (30_000L) and SessionMgr.MAX_HEARTBEAT_INTERVAL (300_000L).

• getMaximumServerKeyAge

  public int getMaximumServerKeyAge()

  Gets the maximum server key age in days.

  Returns:

  A value between 7 and 365 in days.

• setCacheParams

  public void setCacheParams(int minLength, int maxLength, int count)

  Sets the parameters for cache: minLength, maxLength, count.

  Parameters:

  minLength - The minimum length for caching, 7 is the smallest value.

  maxLength - The maximum length for caching, normally 80 or so (maximum 1024).

  count - The count should normally be larger than 200 and smaller than 1000 (maximum 2048).

  Throws:

  IllegalArgumentException - If arguments are not valid.

• getCacheParams

  public int[] getCacheParams()

  Gets the cache parameters as 3 integers in an array, param[0] is minLength, param[1] is maxLength, param[2] is count.

  The default values are minLength=7, maxLength=200, count=700 if nothing is specified.

  Specified by:

  getCacheParams in interface IServerSettings

  Returns:

  Array of 3 integer parameters, param[0] is minLength, param[1] is maxLength, param[2] is count.

• getPortConfigurations

  public WebServerPortConfig[] getPortConfigurations()

  Gets the configured ports.

  Specified by:

  getPortConfigurations in interface IServerSettings

  Returns:

  The array of server port configurations.

• getPortConfiguration

  public WebServerPortConfig getPortConfiguration(String name)

  Gets the port configuration of a name (CC-FIX-APP-DEFINITIONS): the configuration whose name - its WebServerPortConfig.NAME, else its atom name - equals the name, case-sensitive.

  Parameters:

  name - The name.

  Returns:

  The port configuration, or null for none.

• getAllServerAppConfigs

  public ServerAppConfig[] getAllServerAppConfigs()

  Gets the application definitions of all environments of the server configuration, in the order of the file (an entry outside its container, before the migration at load, included).

  Returns:

  The definitions, empty for none.

• findServerAppConfig

  public ServerAppConfig findServerAppConfig(String idOrAlias)

  Finds the application definition of an ID or an alias, over all environments.

  Parameters:

  idOrAlias - The application ID or one of its aliases.

  Returns:

  The definition, or null when no environment defines it.

• checkApplicationDefinitions

  public List<String> checkApplicationDefinitions(PropVerification verification)

  Checks the application definitions of all environments for duplicates: an application ID and every alias must be unique among ALL IDs and aliases of ALL environments (a server runs several environments at once and an application reference carries no environment). The server does not start with a duplicate; iiziGo reports it as an ERROR on both entries.

  Parameters:

  verification - The verification to report the ERRORs into, null for none.

  Returns:

  The messages, one per duplicate, empty for none.

• getLetsEncryptDomains

  public LetsEncryptDomain[] getLetsEncryptDomains()

  Gets the Let's Encrypt domains.

  Returns:

  The array of Let's Encrypt domains.

• getDefaultServerConfigurationEnvironmentName

  public String getDefaultServerConfigurationEnvironmentName()

  Gets the default Server configuration environment name.

  Returns:

  The defined default Server configuration environment name, or "default" if such definition is not done.

• getServerConfigEnvironment

  public ServerConfigEnvProps getServerConfigEnvironment(String name)

  Gets the configuration environment of a name.

  Parameters:

  name - The name (e.g. "test", "development" or "production"), or null for default configuration environment name.

  Returns:

  The configuration setup, or null if not found.

• getServerConfigEnvironments

  public ServerConfigEnvProps[] getServerConfigEnvironments()

  Gets the array of configuration environments present.

• onServerSettingsChanged

  protected void onServerSettingsChanged()

  Called when loaded to update the ServerProps instance.

• getDBCacheMaxFileCount

  public int getDBCacheMaxFileCount()

  Gets the maximum number of cached database files.

  Returns:

  Maximum number of files, minimum 100, default 10_000.

• getDBCacheMaxFileAge

  public long getDBCacheMaxFileAge()

  Gets the maximum file age of cached database files.

  Returns:

  Maximum age in milliseconds of files: minimum 1 hour, default 90 days.

• verify

  public boolean verify(PropVerification verification)

  Verifies this property container. The check performed is the extension of classes and that no circular reference is present.

  Specified by:

  verify in interface IGProp<GProp<?>[]>

  Overrides:

  verify in class PropCnr

  Parameters:

  verification - The property verification class.

  Returns:

  true if verification should proceed, false if disposed of and verification should not take place.

• onApplicationLoad

  public void onApplicationLoad(AppFactory app) throws ServerApplicationSetupException

  Called when the application is loaded.

  Parameters:

  app - The application factory.

  Throws:

  ServerApplicationSetupException - For setup exceptions.

• onApplicationUnload

  public void onApplicationUnload(AppFactory app)

  Called when the application is unloaded.

  Parameters:

  app - The application begin unloaded.

• onApplicationSessionStarted

  public void onApplicationSessionStarted(AppSessionGyro appGyro)

  Called when an application is instantiated and started by a user session.

• onApplicationSessionStopped

  public void onApplicationSessionStopped(AppSessionGyro appGyro)

  Called when an application is stopped.

• getMailSender

  public MailSender getMailSender(String name, ExecutorService executorService, File baseDir) throws NotFoundException, AddressException, NoSuchProviderException, IOException

  Gets the mail sender with the specified name.

  Parameters:

  name - The mail properties name, null for default.

  executorService - The executor service.

  baseDir - The base directory where the server is (generally current directory).

  Returns:

  The mail sender.

  Throws:

  NotFoundException - If the mail sender is not found.

  IOException - If the mail queue directory does not exist.

  NoSuchProviderException - If the "smtp" or "smtps" providers do not exist!

  AddressException - If the default sender failed to parse.

• getRegionLocationGlobalCacheSize

  public int getRegionLocationGlobalCacheSize()

  Gets the global cache size for the region location service providers.

  Returns:

  A value between 100 and 100_000, default is 20_000.

• getRegionLocationAPIKey

  public String getRegionLocationAPIKey(String providerName)

  Gets the API key for a region location service provider.

  Parameters:

  providerName - The provider name, e.g. "IPStack.com".

  Returns:

  The API key, or null if not configured.