Configuration

All Known Implementing Classes:

ConfigurationImpl
```
public interface Configuration
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Configuration.ScheduledEventExecution

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Configuration.ScheduledEventExecution`

Field Summary

Fields
Modifier and Type Field and Description

static RuntimeVersion RUNTIME_VERSION

Fields
Modifier and Type	Field and Description
`static RuntimeVersion`	`RUNTIME_VERSION`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`checkConfig()` Set default values for uninitialized fields if no custom configuration options were supplied, and feed them back again to updateConfiguration.
`boolean`	`enablePersistentSessions()`
`String`	`getAdminUserName()`
`String`	`getAdminUserRoleName()`
`String`	`getApplicationRootUrl()`
`File`	`getBasePath()`
`File`	`getBuiltInDatabasePath()`
`List<InputStream>`	`getCACertificates()`
`List<String>`	`getClientCertificatePasswords()`
`List<InputStream>`	`getClientCertificates()`
`Integer`	`getClientQueryTimeout()`
`long`	`getClusterManagerActionInterval()`
`int`	`getClusterManagerQueryTimeout()`
`Object`	`getConstantValue(com.mendix.core.component.LocalComponent component, String key)`
`Object`	`getConstantValue(String key)`
`long`	`getCSVExportBatchSize()`
`String`	`getDatabaseName()`
`JDBCDataStoreConfiguration`	`getDataStoreConfiguration()`
`HashAlgorithmType`	`getDefaultHashAlgorithm()`
`InternalCore.Mode`	`getDTAPMode()` Deprecated. use isInDevelopment() instead.
`boolean`	`getEnableGuestLogin()`
`String`	`getFileSeparator()`
`String`	`getGuestUserRoleName()`
`String`	`getIFrameUploadDomain()`
`File`	`getImagePath()`
`String`	`getImageUrl()`
`String`	`getJavaKeyStorePassword()`
`Integer`	`getLogMinDurationQuery()`
`Integer`	`getMaxThreadsPerDataStoreRequest()`
`File`	`getModelerFile()`
`File`	`getMxClientSystemPath()`
`Set<String>`	`getMyScheduledEvents()`
`String`	`getNewLine()`
`File`	`getPublicWebrootPath()`
`Boolean`	`getReadCommittedSnapshot()`
`File`	`getResourcesPath()`
`File`	`getRuntimePath()`
`Configuration.ScheduledEventExecution`	`getScheduledEventExecution()`
`String`	`getSessionIdCookieName()`
`int`	`getSessionTimeout()`
`File`	`getTempPath()`
`File`	`getUploadedFilesPath()` Deprecated. this method was for internal use only, use Core.storeFileDocument and Core.retrieveFileDocument instead.
`String`	`getValue(String name)` Deprecated.
`Map<String,WebServiceCertificateInfo>`	`getWebServiceCertificates()`
`String`	`getXASId()`
`boolean`	`hasMicroflowConstantConfig(String key)`
`boolean`	`isClustered()`
`boolean`	`isInDevelopment()`
`boolean`	`isKeepAliveEnabled()`
`Boolean`	`mustReturnOnlyNecessaryDDLCommands()`
`void`	`registerConfigurationSetting(String name, String defaultValue)` Deprecated.
`void`	`setReturnOnlyNecessaryDDLCommands(boolean returnOnlyNecessaryDDLCommands)`
`void`	`setValue(String name, String value)` Deprecated.
`boolean`	`shouldTrackWebServiceUserLastLogin()`
`void`	`updateConfiguration(org.json.JSONObject params, boolean overwrite)` Deprecated.
`void`	`updateConfiguration(Map<String,Object> config, boolean overwrite)`
`boolean`	`useLDAPAuthentication()` Deprecated.

Field Detail

RUNTIME_VERSION

static final RuntimeVersion RUNTIME_VERSION

Method Detail

registerConfigurationSetting

@Deprecated
void registerConfigurationSetting(String name,
                                              String defaultValue)

Deprecated.

getValue

@Deprecated
String getValue(String name)

Deprecated.

setValue

@Deprecated
void setValue(String name,
                          String value)

Deprecated.

updateConfiguration

@Deprecated
void updateConfiguration(org.json.JSONObject params,
                                     boolean overwrite)
                              throws org.json.JSONException

Deprecated.

Throws:: org.json.JSONException

updateConfiguration

void updateConfiguration(Map<String,Object> config,
                         boolean overwrite)

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

Throws:

com.mendix.m2ee.api.AdminException

getXASId
```
String getXASId()
```

getBasePath
```
File getBasePath()
```

getFileSeparator
```
String getFileSeparator()
```
Returns:

the fileSeparator, which is hardcoded to "/": otherwise you can't export forms on Windows and use them on a linux server

getNewLine
```
String getNewLine()
```

getPublicWebrootPath
```
File getPublicWebrootPath()
```

getDataStoreConfiguration

JDBCDataStoreConfiguration getDataStoreConfiguration()

getImagePath
```
File getImagePath()
```

getResourcesPath
```
File getResourcesPath()
```
Returns:

the path to the resources folder, default is model/resources

getImageUrl
```
String getImageUrl()
```

getBuiltInDatabasePath
```
File getBuiltInDatabasePath()
```

getTempPath
```
File getTempPath()
```
Returns:

the path to the temporary files folder, default is data/tmp

getUploadedFilesPath
```
@Deprecated
File getUploadedFilesPath()
```
Deprecated. this method was for internal use only, use Core.storeFileDocument and Core.retrieveFileDocument instead.

Returns:

the path to the files folder, default is data/files

getDefaultHashAlgorithm

HashAlgorithmType getDefaultHashAlgorithm()

getClusterManagerActionInterval
```
long getClusterManagerActionInterval()
```

getSessionTimeout
```
int getSessionTimeout()
```

isKeepAliveEnabled
```
boolean isKeepAliveEnabled()
```

useLDAPAuthentication

@Deprecated
boolean useLDAPAuthentication()

Deprecated.

getApplicationRootUrl
```
String getApplicationRootUrl()
```
Returns:

the server address that the XAS can be reached at. This will be used to generate WSDLs

getIFrameUploadDomain
```
String getIFrameUploadDomain()
```

getModelerFile
```
File getModelerFile()
```

getDTAPMode
```
@Deprecated
InternalCore.Mode getDTAPMode()
```
Deprecated. use isInDevelopment() instead.

isInDevelopment
```
boolean isInDevelopment()
```

getRuntimePath
```
File getRuntimePath()
```

getDatabaseName
```
String getDatabaseName()
```

getReadCommittedSnapshot
```
Boolean getReadCommittedSnapshot()
```

getMaxThreadsPerDataStoreRequest

Integer getMaxThreadsPerDataStoreRequest()

getClientQueryTimeout
```
Integer getClientQueryTimeout()
```

getLogMinDurationQuery
```
Integer getLogMinDurationQuery()
```

mustReturnOnlyNecessaryDDLCommands

Boolean mustReturnOnlyNecessaryDDLCommands()

setReturnOnlyNecessaryDDLCommands

void setReturnOnlyNecessaryDDLCommands(boolean returnOnlyNecessaryDDLCommands)

getConstantValue

Object getConstantValue(com.mendix.core.component.LocalComponent component,
                        String key)

getConstantValue
```
Object getConstantValue(String key)
```

getScheduledEventExecution

Configuration.ScheduledEventExecution getScheduledEventExecution()

getMyScheduledEvents
```
Set<String> getMyScheduledEvents()
```

hasMicroflowConstantConfig

boolean hasMicroflowConstantConfig(String key)

getAdminUserRoleName
```
String getAdminUserRoleName()
```

getAdminUserName
```
String getAdminUserName()
```

getEnableGuestLogin
```
boolean getEnableGuestLogin()
```

getGuestUserRoleName
```
String getGuestUserRoleName()
```

enablePersistentSessions
```
boolean enablePersistentSessions()
```

getMxClientSystemPath
```
File getMxClientSystemPath()
```

getJavaKeyStorePassword
```
String getJavaKeyStorePassword()
```

getCACertificates

List<InputStream> getCACertificates()
                             throws FileNotFoundException

Throws:: FileNotFoundException

getClientCertificates

List<InputStream> getClientCertificates()
                                 throws FileNotFoundException

Throws:: FileNotFoundException

getClientCertificatePasswords

List<String> getClientCertificatePasswords()

getWebServiceCertificates

Map<String,WebServiceCertificateInfo> getWebServiceCertificates()

getCSVExportBatchSize
```
long getCSVExportBatchSize()
```

shouldTrackWebServiceUserLastLogin

boolean shouldTrackWebServiceUserLastLogin()

getSessionIdCookieName
```
String getSessionIdCookieName()
```

getClusterManagerQueryTimeout
```
int getClusterManagerQueryTimeout()
```
Returns:

Query timeout in seconds for the cluster manager.

isClustered
```
boolean isClustered()
```

Interface Configuration

Nested Class Summary

Field Summary

Method Summary

Field Detail

RUNTIME_VERSION

Method Detail

registerConfigurationSetting

getValue

setValue

updateConfiguration

updateConfiguration

checkConfig

getXASId

getBasePath

getFileSeparator

getNewLine

getPublicWebrootPath

getDataStoreConfiguration

getImagePath

getResourcesPath

getImageUrl

getBuiltInDatabasePath

getTempPath

getUploadedFilesPath

getDefaultHashAlgorithm

getClusterManagerActionInterval

getSessionTimeout

isKeepAliveEnabled

useLDAPAuthentication

getApplicationRootUrl

getIFrameUploadDomain

getModelerFile

getDTAPMode

isInDevelopment

getRuntimePath

getDatabaseName

getReadCommittedSnapshot

getMaxThreadsPerDataStoreRequest

getClientQueryTimeout

getLogMinDurationQuery

mustReturnOnlyNecessaryDDLCommands

setReturnOnlyNecessaryDDLCommands

getConstantValue

getConstantValue

getScheduledEventExecution

getMyScheduledEvents

hasMicroflowConstantConfig

getAdminUserRoleName

getAdminUserName

getEnableGuestLogin

getGuestUserRoleName

enablePersistentSessions

getMxClientSystemPath

getJavaKeyStorePassword

getCACertificates

getClientCertificates

getClientCertificatePasswords

getWebServiceCertificates

getCSVExportBatchSize

shouldTrackWebServiceUserLastLogin

getSessionIdCookieName

getClusterManagerQueryTimeout

isClustered