Interface Configuration

public interface Configuration
Provides the interface for various runtime configuration settings.
  • Field Details

  • Method Details

    • updateConfiguration

      void updateConfiguration(Map<String,Object> config, boolean overwrite)
      Updates the current configuration with the specified configuration settings.
      config - the configuration settings to update
      overwrite - true if existing settings should be overwritten; false otherwise
    • checkConfig

      void checkConfig() throws AdminException
      Set default values for uninitialized fields if no custom configuration options were supplied, and feed them back again to updateConfiguration.
    • getXASId

      String getXASId()
      Returns the identifier of this runtime server instance.
    • getBasePath

      File getBasePath()
      Returns the location on the local file system of the project deployment (i.e. the deployment directory).
    • getFileSeparator

      String getFileSeparator()
      Returns the file path separator, which is hardcoded to "/", so that forms can be exported on Windows and used on Linux.
    • getNewLine

      String getNewLine()
      Returns the line separation character(s).
    • getPublicWebrootPath

      File getPublicWebrootPath()
      Returns the root location in the local file system for the public web server.
    • getImagePath

      File getImagePath()
      Returns the location in the local file system for images.
    • getResourcesPath

      File getResourcesPath()
      Returns the path to the resources folder; the default is model/resources.
    • getImageUrl

      String getImageUrl()
      Returns the relative URL path for images.
    • getTempPath

      File getTempPath()
      Returns the path to the temporary files folder; the default is data/tmp.
    • getSessionKeepAliveUpdatesInterval

      long getSessionKeepAliveUpdatesInterval()
      Returns the interval (in milliseconds) used for performing keep alive updates on sessions.
    • getClusterManagerActionInterval

      long getClusterManagerActionInterval()
      Returns the interval (in milliseconds) used for performing all cluster manager actions.
    • getSessionTimeout

      int getSessionTimeout()
      Returns after how much time a session becomes invalid (in milliseconds).
    • getSessionValidationTimeout

      int getSessionValidationTimeout()
      Returns the interval (in milliseconds) after which cached sessions need to be revalidated in the runtime server.
    • isKeepAliveEnabled

      boolean isKeepAliveEnabled()
      Returns whether the web client sends a keep alive request to prevent a session timeout.
    • isFileDocumentCachingEnabled

      boolean isFileDocumentCachingEnabled()
      Returns whether file document caching is enabled.
    • isStrictChangeHashVerificationEnabled

      boolean isStrictChangeHashVerificationEnabled()
      Returns whether change hashes are verified in a strict mode.
    • getApplicationRootUrl

      String getApplicationRootUrl()
      Returns the server address that the run-time can be reached at. This is used to generate WSDLs.
    • getIFrameUploadDomain

      String getIFrameUploadDomain()
      Returns the document domain name.
    • getModelerFile

      File getModelerFile()
      Returns the location on the local file system of the project file.
    • isInDevelopment

      boolean isInDevelopment()
      Returns whether this runtime server is running in development mode, which is determined from the DTAPMode custom runtime setting.
      true if the DTAPMode is development or testing, false otherwise
    • getRuntimePath

      File getRuntimePath()
      Returns the location on the local file system of the runtime bundles.
    • getClientQueryTimeout

      Integer getClientQueryTimeout()
      Returns the timeout in seconds for most of the database queries which are executed to load data into client widgets, like data grids.
    • getConstantValue

      Object getConstantValue(String key)
      Returns the value for the constant with the specified name.
      key - the name of the constant
      the value of the constant if it exists
      MendixRuntimeException - if the constant does not exist
    • getPublicConstants

      Set<String> getPublicConstants()
      Returns the names of all publicly defined constants.
      the names of the constants
    • getScheduledEventExecution

      Configuration.ScheduledEventExecution getScheduledEventExecution()
      Returns which scheduled events should be executed (all, specified, none).
    • getMyScheduledEvents

      Set<String> getMyScheduledEvents()
      Returns the (qualified) names of the scheduled events from the project.
    • hasMicroflowConstantConfig

      boolean hasMicroflowConstantConfig(String key)
      Returns whether the microflow constants contain the specified name.
      key - the name of the microflow constant
    • getAdminUserRoleName

      String getAdminUserRoleName()
      Returns the name of the admin role.
    • getAdminUserName

      String getAdminUserName()
      Returns the name of the admin user.
    • getEnableGuestLogin

      boolean getEnableGuestLogin()
      Returns whether guest logins are enabled.
    • getGuestUserRoleName

      String getGuestUserRoleName()
      Returns the role name for guest users.
    • enablePersistentSessions

      @Deprecated default boolean enablePersistentSessions()
      since Mendix 9. Support for non-persistent sessions is removed. This method should not be used any more.
      This method always returns false.
    • getMxClientSystemPath

      File getMxClientSystemPath()
      Returns the location of the client files on the local filesystem.
    • getJavaKeyStorePassword

      String getJavaKeyStorePassword()
      Returns the password of the Java keystore.
    • getCACertificates

      List<InputStream> getCACertificates() throws IOException
      Returns all configured CA certificates.
    • getClientCertificates

      List<InputStream> getClientCertificates() throws IOException
      Returns all configured client certificates.
    • getClientCertificatePasswords

      List<String> getClientCertificatePasswords()
      Returns the password for all configured client certificates.
    • getCSVExportBatchSize

      long getCSVExportBatchSize()
      Returns the batch size for CSV exports.
    • shouldTrackWebServiceUserLastLogin

      boolean shouldTrackWebServiceUserLastLogin()
      Returns whether to update the web service user's LastLogin field on each login.
    • getSessionIdCookieName

      String getSessionIdCookieName()
      Returns the name of the HTTP header field for session cookies.
    • getClusterManagerQueryTimeout

      int getClusterManagerQueryTimeout()
      Returns the cluster manager query timeout (in seconds).
      the timeout in seconds
    • isLocalFileSystemCleaningEnabled

      boolean isLocalFileSystemCleaningEnabled()
      Returns whether cleaning orphan files on the local file system is enabled.
    • getStorageService

      String getStorageService()
      Returns the name of the storage service module that is used.