Package com.smartgwt.client.docs
Interface Server_properties
public interface Server_properties
server.properties file
The server.properties file is a configuration file read by the Smart GWT server -
see the file itself for more information and default or sample settings. Note that this is a standard Java Properties file, except it allows variable substitution from other properties defined earlier in the file.
It's loaded from the CLASSPATH, so it can be
anywhere in the CLASSPATH, but is typically either in the projects java "src"
directory or in WEB-INF/classes.
Server side code can access and modify the
properties specified in this file via the com.isomorphic.base.Config class.
When modifying server.properties developers should restart the servlet engine
after changing this file to pick up changes.
The following settings are used by Smart GWT
server features.
Note that this is not intended to be an exhaustive list:
project.datasourcesspecifies the location forserver-backed DataSource configuration files (*.ds.xml files)as well asserver-backed SimpleType declarations (*.type.xml files)project.uispecifies the location forXML Screen definitions (*.ui.xml files)project.projectspecifies the location forXML Project definitions (*.project.xml files)project.appsspecifies the location forApplication declarations (*.app.xml files)modulesDirspecifies the location for modules files if using theloadISCorloadModulesjsp tags.isc.addVersionToLoadTags(boolean) May be set to false to disable the automatic versioning applied to URLs written out byloadISCorloadModulesjsp tags.isc.defaultVersionStylespecifies the defaultversionStyleforloadISCorloadModulesjsp tags. Default value is "params".isc.versionPathSegmentPrefixSpecifies a standard path segment prefix written out byloadISCorloadModulesjsp tags withversionStyleset to "pathSegment". The generated path segment will consist of this prefix combined with the current Smart GWT version. The default value is"isc_version.".isc.stripVersionPathSegments(boolean) When set to true, any URL containing a path segment that starts with theisc.pathSegmentPrefixwill be automatically stripped by the Smart GWT FileDownloadServlet, or the dedicated VersionedURLFilter when resolving the URL to a resource on the filesystem.
This may be disabled if you want to use a different strategy such as using Apache mod_rewrite on a dedicated web server to resolve URLs including versioned path segments.authentication.defaultRequiredcan be used to requireauthenticationfor all dataSources by defaultauthentication.superuserRolecan be used to identify auser roleas the super user role.- This file can contain
DataBase configuration settings for SQL DataSources. Note that theAdmin Console toolprovides an interface for adding database configuration blocks to server.properties without the need to edit the file by hand. - This file can contain
SQL Connection poolingsettings for SQL DataSources. - This file can contain various
configuration properties used for
JpaIntegration - This
file can contain SMTP configuration settings for the
OperationBinding.mailfeature. - This file can
contain configuration settings for the
optional RealTimeMessaging module. enabledBuiltinscan be used to configure access to methods provided by the server sideBuiltInRPCclass. (See server side JavaDoc for that class as well as thetools deployment overviewfor more information).domainSync.disabledanddomainSync.baseDomainscan be used toconfigure domain synching behavior.import.consume.bomcan be set to false to switch off automatic consumption of Byte Order Markers when importing UTF data (see the server Javadocs for the DataImport class for more details)datasources.autoConvertRelativeDatescan be used to change when relative dates are converted or to entirely disable the automatic conversion (seeDataSource.autoConvertRelativeDatesfor more details)sql.log.formatQueriescan be set totrueto enable the SQL queries formatting inserver logsundercom.isomorphic.sql.SQLDrivercategorysql.log.compactFormattingcan be set totrueto make formatted SQL queries more compactsql.log.maxLengthcan be set to an integer controlling the maximum length of formatted SQL queriessql.log.queriesSlowerThancan be set to an integer controlling SQL query execution time threshold in milliseconds (defaults to 10000), which if exceeded query is identified as "slow" and may be logged under specific logging category. SeeDataSource.logSlowSQLfor more details.reflection.classCachespecifies how (if enabled) Smartclient Reflection library caches loaded classes, availables values are "global", "classloader" (default), "jdk" and "off". See comment in server.properties for more details.sql_comment_mdc_keyif specified is used as a logging MDC key to get the configurable "log_correlation_id" third party tools, like Dynatrace, Graylog etc., use for the context. Smartclient picks that from the logging MDC and adds as a comment to the end of generated SQL queries, so those can be connected to the context.