SettingsBean (Jahia Server Implementation 8.0.3.0 API)

java.lang.Object
- org.jahia.settings.SettingsBean

All Implemented Interfaces:

SettingsBean, ReadOnlyModeCapable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware
```
public class SettingsBean
extends Object
implements org.springframework.web.context.ServletContextAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, ReadOnlyModeCapable, SettingsBean
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JAHIA_BACKUP_RESTORE_SYSTEM_PROP` Deprecated. Use `isStartupOptionSet(String)` instead
`static String`	`JAHIA_PROPERTIES_FILE_PATH`

Constructor Summary

Constructors
Constructor and Description
`SettingsBean(PathResolver pathResolver, Properties props, List<String> licenseFileLocations)`
`SettingsBean(PathResolver pathResolver, String propertiesFilename, String licenseFilename, String buildNumber)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`static String`	`convertContexted(String convert, PathResolver pathResolver)` Convert a String starting with the word "$context" into a real filesystem path.
`static String`	`convertWebContexted(String convert)` Convert a string starting with the word "$webContext" into a real filesystem path.
`int`	`getAccessManagerPathPermissionCacheMaxSize()`
`org.springframework.context.ApplicationContext`	`getApplicationContext()`
`String`	`getAtmosphereAsyncSupport()`
`String`	`getAtmosphereHeartbeatFrequency()`
`String[]`	`getAuthorizedRedirectHosts()`
`boolean`	`getBoolean(String propertyName, boolean defaultValue)`
`String`	`getBuildNumber()` Used to get the build number.
`String`	`getCharacterEncoding()`
`String`	`getClassDiskPath()`
`CookieAuthConfig`	`getCookieAuthConfig()`
`String`	`getDefaultLanguageCode()`
`Locale`	`getDefaultLocale()`
`static File`	`getErrorDir()` Returns the directory where the automatic error reports are generated by Jahia.
`String`	`getExpandImportedFilesOnDiskPath()`
`int`	`getFileDumpMaxRegroupingOfPreviousException()`
`String`	`getGuestGroupResourceKey()`
`String`	`getGuestGroupResourceModuleName()`
`String`	`getGuestUserResourceKey()`
`String`	`getGuestUserResourceModuleName()`
`static File`	`getHeapDir()` Returns the directory where the triggered heap dumps are generated by Digital Experience Manager.
`int`	`getImportMaxBatch()`
`static SettingsBean`	`getInstance()`
`int`	`getInt(String propertyName, int defaultValue)`
`String`	`getInternetExplorerCompatibility()`
`String`	`getJahiaDatabaseScriptsPath()`
`String`	`getJahiaEtcDiskPath()` Used to get the jahiafiles /etc disk path.
`String`	`getJahiaExportsDiskPath()`
`long`	`getJahiaFileUploadMaxSize()`
`String`	`getJahiaGeneratedResourcesDiskPath()`
`String`	`getJahiaHomeDiskPath()` Deprecated. since 7.0.0.2
`String`	`getJahiaImportsDiskPath()`
`long`	`getJahiaJCRUserCountLimit()`
`String`	`getJahiaModulesDiskPath()` Used to get the shared templates disk path.
`int`	`getJahiaSiteImportScannerInterval()`
`String`	`getJahiaVarDiskPath()` Used to get the jahiafiles /var disk path.
`String`	`getJahiaWebAppsDeployerBaseURL()`
`String`	`getJsessionIdParameterName()`
`org.springframework.core.io.Resource`	`getLicenseFile()`
`String`	`getLicenseFileName()`
`long`	`getLong(String propertyName, long defaultValue)`
`int`	`getMail_maxRegroupingOfPreviousException()`
`int`	`getMaxNameSize()`
`int`	`getModuleSpringBeansWaitingTimeout()`
`String`	`getModulesSourcesDiskPath()`
`int`	`getModuleStartLevel()`
`String`	`getOperatingMode()`
`PathResolver`	`getPathResolver()`
`Properties`	`getPropertiesFile()` Get the principal properties object.
`String`	`getPropertyValue(String propertyName)`
`int`	`getQueryApproxCountLimit()`
`int`	`getReadOnlyModePriority()` Get the priority of the service.
`File`	`getRepositoryHome()`
`org.springframework.core.io.Resource`	`getRepositoryHomeResource()`
`String`	`getServer()` Used to get the server name (tomcat, orion, etc).
`org.jahia.configuration.deployers.ServerDeploymentInterface`	`getServerDeployer()`
`String`	`getServerHome()` Used to get the server home filesystem disk path.
`String`	`getServerVersion()`
`javax.servlet.ServletContext`	`getServletContext()`
`int`	`getSessionExpiryTime()`
`boolean`	`getSiteErrorEnabled()` to get the Site errors page behavior
`int`	`getSiteURLPortOverride()`
`StartupOptions`	`getStartupOptions()` Returns the startup options, which are set.
`String`	`getString(String propertyName)`
`String`	`getString(String propertyName, String defaultValue)`
`long`	`getStudioMaxDisplayableFileSize()`
`String`	`getTemplatesContext()` Used to get the templates context.
`static File`	`getThreadDir()` Returns the directory where the automatic or triggered thread dumps are generated by Jahia.
`String`	`getTmpContentDiskPath()`
`void`	`initPaths()`
`boolean`	`isAreaAutoActivated()`
`boolean`	`isClusterActivated()` Returns `true` if the clustering is activated.
`boolean`	`isConsiderDefaultJVMLocale()`
`boolean`	`isConsiderPreferredLanguageAfterLogin()`
`boolean`	`isDevelopmentMode()`
`boolean`	`isDisableJsessionIdParameter()`
`boolean`	`isDistantPublicationServerMode()`
`boolean`	`isDumpErrorsToFiles()`
`boolean`	`isExpandImportedFilesOnDisk()`
`boolean`	`isFileServletStatisticsEnabled()`
`boolean`	`isFullReadOnlyMode()` Returns `true` if this Jahia instance operates in "full-read-only" mode, i.e.
`boolean`	`isMaintenanceMode()`
`boolean`	`isMavenExecutableSet()`
`boolean`	`isPermanentMoveForVanityURL()`
`boolean`	`isProcessingServer()`
`boolean`	`isProductionMode()`
`boolean`	`isReadOnlyMode()` Returns `true` if this Jahia instance operates in "read-only" mode, i.e.
`boolean`	`isStartupOptionSet(String option)` Checks if the specified startup option is set.
`boolean`	`isUrlRewriteRemoveCmsPrefix()`
`boolean`	`isUrlRewriteSeoRulesEnabled()`
`boolean`	`isUrlRewriteUseAbsoluteUrls()`
`boolean`	`isUseJstackForThreadDumps()`
`boolean`	`isUseRelativeSiteURLs()` Activation / deactivation of relative URLs, instead of absolute URLs, when generating URL to exit the Admin Menu for example
`boolean`	`isUseWebsockets()`
`void`	`load()` This method load and convert properties from the jahia.properties file, and set some variables used by the SettingsBean class.
`boolean`	`lookupBoolean(String key)` Looks up the specified `key` parameter as a `boolean` result.
`int`	`lookupInt(String key)` Looks up the specified `key` parameter as a `long` result.
`long`	`lookupLong(String key)` Looks up the specified `key` parameter as a `long` result.
`String`	`lookupString(String key)` Looks up the specified `key` parameter as a `String` result.
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`void`	`setAtmosphereAsyncSupport(String atmosphereAsyncSupport)`
`void`	`setBuildNumber(String buildNumber)`
`void`	`setClusterSettingsInitializer(ClusterSettingsInitializer clusterSettingsInitializer)`
`void`	`setConsiderDefaultJVMLocale(boolean considerDefaultJVMLocale)`
`void`	`setConsiderPreferredLanguageAfterLogin(boolean considerPreferredLanguageAfterLogin)`
`void`	`setCookieAuthConfig(CookieAuthConfig cookieAuthConfig)`
`void`	`setDataSource(DataSource dataSource)`
`void`	`setDisableJsessionIdParameter(boolean disableJsessionIdParameter)`
`void`	`setDumpErrorsToFiles(boolean dumpErrorsToFiles)`
`void`	`setGuestGroupResourceKey(String guestGroupResourceKey)`
`void`	`setGuestGroupResourceModuleName(String guestGroupResourceModuleName)`
`void`	`setJahiaJCRUserCountLimit(long jahiaJCRUserCountLimit)`
`void`	`setJsessionIdParameterName(String jsessionIdParameterName)`
`void`	`setLicenseFile(org.springframework.core.io.Resource licenseFile)`
`void`	`setMail_maxRegroupingOfPreviousException(int mail_maxRegroupingOfPreviousException)`
`void`	`setMavenExecutableSet(boolean isMavenExecutableSet)`
`void`	`setModuleSpringBeansWaitingTimeout(int moduleSpringBeansWaitingTimeout)`
`void`	`setPathResolver(PathResolver pathResolver)`
`void`	`setReadOnlyMode(boolean readOnlyMode)` If set to `true`, access to the edit/studio/administration modes is disabled on this Jahia instance.
`void`	`setServletContext(javax.servlet.ServletContext servletContext)`
`void`	`setSessionExpiryTime(int sessionExpiryTime)`
`void`	`setSiteURLPortOverride(int siteURLPortOverride)`
`void`	`setStartupOptionsMapping(Map<String,Set<String>> startupOptionsMapping)`
`void`	`setUseRelativeSiteURLs(boolean val)`
`void`	`setUseWebsockets(boolean useWebsockets)`
`void`	`switchReadOnlyMode(boolean enable)` Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JAHIA_PROPERTIES_FILE_PATH
```
public static final String JAHIA_PROPERTIES_FILE_PATH
```
    See Also:
    
    Constant Field Values
  - JAHIA_BACKUP_RESTORE_SYSTEM_PROP
```
@Deprecated
public static final String JAHIA_BACKUP_RESTORE_SYSTEM_PROP
```
    Deprecated. Use isStartupOptionSet(String) instead
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SettingsBean
```
public SettingsBean(PathResolver pathResolver,
                    String propertiesFilename,
                    String licenseFilename,
                    String buildNumber)
```
    Parameters:
    
    pathResolver - a path resolver used to locate files on the disk.
    
    propertiesFilename - The jahia.properties file complete path.
    
    licenseFilename - the name of the license file.
    
    buildNumber - The Jahia build number.
  - SettingsBean
```
public SettingsBean(PathResolver pathResolver,
                    Properties props,
                    List<String> licenseFileLocations)
```
- Method Detail
  - getInstance
```
public static SettingsBean getInstance()
```
  - getErrorDir
```
public static File getErrorDir()
```
    Returns the directory where the automatic error reports are generated by Jahia.
    
    Returns:
    
    the directory where the automatic error reports are generated by Jahia
  - getThreadDir
```
public static File getThreadDir()
```
    Returns the directory where the automatic or triggered thread dumps are generated by Jahia.
    
    Returns:
    
    the directory where the automatic or triggered thread dumps are generated by Digital Experience Manager
  - getHeapDir
```
public static File getHeapDir()
```
    Returns the directory where the triggered heap dumps are generated by Digital Experience Manager.
    
    Returns:
    
    the directory where the triggered heap dumps are generated by Digital Experience Manager
  - getJahiaDatabaseScriptsPath
```
public String getJahiaDatabaseScriptsPath()
```
    Specified by:
    
    getJahiaDatabaseScriptsPath in interface SettingsBean
  - getJahiaJCRUserCountLimit
```
public long getJahiaJCRUserCountLimit()
```
    Specified by:
    
    getJahiaJCRUserCountLimit in interface SettingsBean
  - getAtmosphereHeartbeatFrequency
```
public String getAtmosphereHeartbeatFrequency()
```
  - setJahiaJCRUserCountLimit
```
public void setJahiaJCRUserCountLimit(long jahiaJCRUserCountLimit)
```
  - load
```
public void load()
```
    This method load and convert properties from the jahia.properties file, and set some variables used by the SettingsBean class.
    
    Specified by:
    
    load in interface SettingsBean
  - getModuleStartLevel
```
public int getModuleStartLevel()
```
    Specified by:
    
    getModuleStartLevel in interface SettingsBean
  - initPaths
```
public void initPaths()
```
  - isClusterActivated
```
public boolean isClusterActivated()
```
    Returns true if the clustering is activated.
    
    Specified by:
    
    isClusterActivated in interface SettingsBean
    
    Returns:
    
    true if the clustering is activated; false otherwise
  - getRepositoryHome
```
public File getRepositoryHome()
                       throws IOException
```
    Specified by:
    
    getRepositoryHome in interface SettingsBean
    
    Throws:
    
    IOException
  - getRepositoryHomeResource
```
public org.springframework.core.io.Resource getRepositoryHomeResource()
                                                               throws IOException
```
    Throws:
    
    IOException
  - getDefaultLocale
```
public Locale getDefaultLocale()
```
    Specified by:
    
    getDefaultLocale in interface SettingsBean
  - getBoolean
```
public boolean getBoolean(String propertyName,
                          boolean defaultValue)
```
    Specified by:
    
    getBoolean in interface SettingsBean
  - getString
```
public String getString(String propertyName)
                 throws NoSuchElementException
```
    Specified by:
    
    getString in interface SettingsBean
    
    Throws:
    
    NoSuchElementException
  - getString
```
public String getString(String propertyName,
                        String defaultValue)
```
    Specified by:
    
    getString in interface SettingsBean
  - getInt
```
public int getInt(String propertyName,
                  int defaultValue)
```
    Specified by:
    
    getInt in interface SettingsBean
  - getLong
```
public long getLong(String propertyName,
                    long defaultValue)
```
    Specified by:
    
    getLong in interface SettingsBean
  - getPropertyValue
```
public String getPropertyValue(String propertyName)
```
    Specified by:
    
    getPropertyValue in interface SettingsBean
  - lookupString
```
public String lookupString(String key)
```
    Looks up the specified key parameter as a String result.
    
    Specified by:
    
    lookupString in interface SettingsBean
    
    Parameters:
    
    key - the parameter key to lookup
    
    Returns:
    
    the requested parameter value. Returns null when the parameter could not be found.
  - lookupBoolean
```
public boolean lookupBoolean(String key)
```
    Looks up the specified key parameter as a boolean result.
    
    Specified by:
    
    lookupBoolean in interface SettingsBean
    
    Parameters:
    
    key - the parameter key to lookup
    
    Returns:
    
    the requested parameter value. Return false when the parameter could not be found.
  - lookupLong
```
public long lookupLong(String key)
```
    Looks up the specified key parameter as a long result.
    
    Specified by:
    
    lookupLong in interface SettingsBean
    
    Parameters:
    
    key - the parameter key to lookup
    
    Returns:
    
    the requested parameter value. Return Long.MIN_VALUE when the parameter could not be found.
  - lookupInt
```
public int lookupInt(String key)
```
    Looks up the specified key parameter as a long result.
    
    Specified by:
    
    lookupInt in interface SettingsBean
    
    Parameters:
    
    key - the parameter key to lookup
    
    Returns:
    
    the requested parameter value. Return Long.MIN_VALUE when the parameter could not be found.
  - getPropertiesFile
```
public Properties getPropertiesFile()
```
    Get the principal properties object.
    
    Specified by:
    
    getPropertiesFile in interface SettingsBean
    
    Returns:
    
    Properties object containing all properties from jahia.properties file.
  - getLicenseFileName
```
public String getLicenseFileName()
```
    Specified by:
    
    getLicenseFileName in interface SettingsBean
  - isUseRelativeSiteURLs
```
public boolean isUseRelativeSiteURLs()
```
    Activation / deactivation of relative URLs, instead of absolute URLs, when generating URL to exit the Admin Menu for example
    
    Specified by:
    
    isUseRelativeSiteURLs in interface SettingsBean
  - setUseRelativeSiteURLs
```
public void setUseRelativeSiteURLs(boolean val)
```
  - getJahiaWebAppsDeployerBaseURL
```
public String getJahiaWebAppsDeployerBaseURL()
```
    Specified by:
    
    getJahiaWebAppsDeployerBaseURL in interface SettingsBean
  - getDefaultLanguageCode
```
public String getDefaultLanguageCode()
```
    Specified by:
    
    getDefaultLanguageCode in interface SettingsBean
  - getBuildNumber
```
public String getBuildNumber()
```
    Used to get the build number.
    
    Specified by:
    
    getBuildNumber in interface SettingsBean
    
    Returns:
    
    The build number.
  - setBuildNumber
```
public void setBuildNumber(String buildNumber)
```
  - getServer
```
public String getServer()
```
    Used to get the server name (tomcat, orion, etc).
    
    Specified by:
    
    getServer in interface SettingsBean
    
    Returns:
    
    The server name.
  - getServerHome
```
public String getServerHome()
```
    Used to get the server home filesystem disk path.
    
    Specified by:
    
    getServerHome in interface SettingsBean
    
    Returns:
    
    The server home filesystem disk path.
  - getJahiaEtcDiskPath
```
public String getJahiaEtcDiskPath()
```
    Used to get the jahiafiles /etc disk path.
    
    Specified by:
    
    getJahiaEtcDiskPath in interface SettingsBean
    
    Returns:
    
    The jahiafiles /etc disk path.
  - getJahiaVarDiskPath
```
public String getJahiaVarDiskPath()
```
    Used to get the jahiafiles /var disk path.
    
    Specified by:
    
    getJahiaVarDiskPath in interface SettingsBean
    
    Returns:
    
    The jahiafiles /var disk path.
  - getJahiaModulesDiskPath
```
public String getJahiaModulesDiskPath()
```
    Used to get the shared templates disk path.
    
    Specified by:
    
    getJahiaModulesDiskPath in interface SettingsBean
    
    Returns:
    
    The shared templates disk path.
  - getJahiaGeneratedResourcesDiskPath
```
public String getJahiaGeneratedResourcesDiskPath()
```
    Specified by:
    
    getJahiaGeneratedResourcesDiskPath in interface SettingsBean
    
    Returns:
    
    The generated resources disk path.
  - getClassDiskPath
```
public String getClassDiskPath()
```
    Specified by:
    
    getClassDiskPath in interface SettingsBean
  - getJahiaFileUploadMaxSize
```
public long getJahiaFileUploadMaxSize()
```
    Specified by:
    
    getJahiaFileUploadMaxSize in interface SettingsBean
  - getJahiaHomeDiskPath
```
@Deprecated
public String getJahiaHomeDiskPath()
```
    Deprecated. since 7.0.0.2
    
    Specified by:
    
    getJahiaHomeDiskPath in interface SettingsBean
  - getJahiaImportsDiskPath
```
public String getJahiaImportsDiskPath()
```
    Specified by:
    
    getJahiaImportsDiskPath in interface SettingsBean
  - getJahiaExportsDiskPath
```
public String getJahiaExportsDiskPath()
```
    Specified by:
    
    getJahiaExportsDiskPath in interface SettingsBean
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface SettingsBean
  - getPathResolver
```
public PathResolver getPathResolver()
```
  - setPathResolver
```
public void setPathResolver(PathResolver pathResolver)
```
  - getTmpContentDiskPath
```
public String getTmpContentDiskPath()
```
    Specified by:
    
    getTmpContentDiskPath in interface SettingsBean
  - getModulesSourcesDiskPath
```
public String getModulesSourcesDiskPath()
```
    Specified by:
    
    getModulesSourcesDiskPath in interface SettingsBean
  - isProcessingServer
```
public boolean isProcessingServer()
```
    Specified by:
    
    isProcessingServer in interface SettingsBean
  - getSiteURLPortOverride
```
public int getSiteURLPortOverride()
```
    Specified by:
    
    getSiteURLPortOverride in interface SettingsBean
  - setSiteURLPortOverride
```
public void setSiteURLPortOverride(int siteURLPortOverride)
```
    Specified by:
    
    setSiteURLPortOverride in interface SettingsBean
  - getMail_maxRegroupingOfPreviousException
```
public int getMail_maxRegroupingOfPreviousException()
```
  - setMail_maxRegroupingOfPreviousException
```
public void setMail_maxRegroupingOfPreviousException(int mail_maxRegroupingOfPreviousException)
```
  - isDevelopmentMode
```
public boolean isDevelopmentMode()
```
    Specified by:
    
    isDevelopmentMode in interface SettingsBean
  - getSiteErrorEnabled
```
public boolean getSiteErrorEnabled()
```
    to get the Site errors page behavior
    
    Specified by:
    
    getSiteErrorEnabled in interface SettingsBean
    
    Returns:
    
    a boolean
  - isConsiderDefaultJVMLocale
```
public boolean isConsiderDefaultJVMLocale()
```
    Specified by:
    
    isConsiderDefaultJVMLocale in interface SettingsBean
  - setConsiderDefaultJVMLocale
```
public void setConsiderDefaultJVMLocale(boolean considerDefaultJVMLocale)
```
  - isConsiderPreferredLanguageAfterLogin
```
public boolean isConsiderPreferredLanguageAfterLogin()
```
    Specified by:
    
    isConsiderPreferredLanguageAfterLogin in interface SettingsBean
  - setConsiderPreferredLanguageAfterLogin
```
public void setConsiderPreferredLanguageAfterLogin(boolean considerPreferredLanguageAfterLogin)
```
  - isPermanentMoveForVanityURL
```
public boolean isPermanentMoveForVanityURL()
```
    Specified by:
    
    isPermanentMoveForVanityURL in interface SettingsBean
  - isDumpErrorsToFiles
```
public boolean isDumpErrorsToFiles()
```
    Specified by:
    
    isDumpErrorsToFiles in interface SettingsBean
  - setDumpErrorsToFiles
```
public void setDumpErrorsToFiles(boolean dumpErrorsToFiles)
```
  - getFileDumpMaxRegroupingOfPreviousException
```
public int getFileDumpMaxRegroupingOfPreviousException()
```
    Specified by:
    
    getFileDumpMaxRegroupingOfPreviousException in interface SettingsBean
  - getServerVersion
```
public String getServerVersion()
```
    Specified by:
    
    getServerVersion in interface SettingsBean
    
    Returns:
    
    the serverVersion
  - getServerDeployer
```
public org.jahia.configuration.deployers.ServerDeploymentInterface getServerDeployer()
```
    Specified by:
    
    getServerDeployer in interface SettingsBean
    
    Returns:
    
    the serverDeployer
  - isMaintenanceMode
```
public boolean isMaintenanceMode()
```
    Specified by:
    
    isMaintenanceMode in interface SettingsBean
  - getSessionExpiryTime
```
public int getSessionExpiryTime()
```
    Specified by:
    
    getSessionExpiryTime in interface SettingsBean
  - setSessionExpiryTime
```
public void setSessionExpiryTime(int sessionExpiryTime)
```
  - isDisableJsessionIdParameter
```
public boolean isDisableJsessionIdParameter()
```
    Specified by:
    
    isDisableJsessionIdParameter in interface SettingsBean
  - setDisableJsessionIdParameter
```
public void setDisableJsessionIdParameter(boolean disableJsessionIdParameter)
```
  - getJsessionIdParameterName
```
public String getJsessionIdParameterName()
```
    Specified by:
    
    getJsessionIdParameterName in interface SettingsBean
  - setJsessionIdParameterName
```
public void setJsessionIdParameterName(String jsessionIdParameterName)
```
  - getGuestUserResourceKey
```
public String getGuestUserResourceKey()
```
    Specified by:
    
    getGuestUserResourceKey in interface SettingsBean
  - getGuestUserResourceModuleName
```
public String getGuestUserResourceModuleName()
```
    Specified by:
    
    getGuestUserResourceModuleName in interface SettingsBean
  - getGuestGroupResourceModuleName
```
public String getGuestGroupResourceModuleName()
```
    Specified by:
    
    getGuestGroupResourceModuleName in interface SettingsBean
  - setGuestGroupResourceModuleName
```
public void setGuestGroupResourceModuleName(String guestGroupResourceModuleName)
```
  - getGuestGroupResourceKey
```
public String getGuestGroupResourceKey()
```
    Specified by:
    
    getGuestGroupResourceKey in interface SettingsBean
  - setGuestGroupResourceKey
```
public void setGuestGroupResourceKey(String guestGroupResourceKey)
```
  - convertContexted
```
public static String convertContexted(String convert,
                                      PathResolver pathResolver)
```
    Convert a String starting with the word "$context" into a real filesystem path. This method is principally used by JahiaPrivateSettings and to convert jahia.properties settings.
    
    Parameters:
    
    convert - The string to convert.
    
    pathResolver - The path resolver used to get the real path.
  - convertWebContexted
```
public static String convertWebContexted(String convert)
```
    Convert a string starting with the word "$webContext" into a real filesystem path.
    
    Parameters:
    
    convert - the string to convert
    
    Returns:
    
    converted string
  - setServletContext
```
public void setServletContext(javax.servlet.ServletContext servletContext)
```
    Specified by:
    
    setServletContext in interface org.springframework.web.context.ServletContextAware
  - getServletContext
```
public javax.servlet.ServletContext getServletContext()
```
  - getTemplatesContext
```
public String getTemplatesContext()
```
    Used to get the templates context.
    
    Specified by:
    
    getTemplatesContext in interface SettingsBean
    
    Returns:
    
    The templates context.
  - getLicenseFile
```
public org.springframework.core.io.Resource getLicenseFile()
```
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - getApplicationContext
```
public org.springframework.context.ApplicationContext getApplicationContext()
```
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
    
    Throws:
    
    Exception
  - switchReadOnlyMode
```
public void switchReadOnlyMode(boolean enable)
```
    Description copied from interface: ReadOnlyModeCapable
    
    Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.
    
    Specified by:
    
    switchReadOnlyMode in interface SettingsBean
    
    Specified by:
    
    switchReadOnlyMode in interface ReadOnlyModeCapable
    
    Parameters:
    
    enable - true in case the read-only mode should be enabled; false otherwise
  - getReadOnlyModePriority
```
public int getReadOnlyModePriority()
```
    Description copied from interface: ReadOnlyModeCapable
    
    Get the priority of the service.
    
    Specified by:
    
    getReadOnlyModePriority in interface SettingsBean
    
    Specified by:
    
    getReadOnlyModePriority in interface ReadOnlyModeCapable
    
    Returns:
    
    the priority of the service; higher priority means earlier invocation of switchReadOnlyMode when switching read only mode on, and later invocation when switching it off
  - getOperatingMode
```
public String getOperatingMode()
```
    Specified by:
    
    getOperatingMode in interface SettingsBean
  - isProductionMode
```
public boolean isProductionMode()
```
    Specified by:
    
    isProductionMode in interface SettingsBean
  - isDistantPublicationServerMode
```
public boolean isDistantPublicationServerMode()
```
    Specified by:
    
    isDistantPublicationServerMode in interface SettingsBean
  - isUseJstackForThreadDumps
```
public boolean isUseJstackForThreadDumps()
```
    Specified by:
    
    isUseJstackForThreadDumps in interface SettingsBean
  - isUrlRewriteSeoRulesEnabled
```
public boolean isUrlRewriteSeoRulesEnabled()
```
    Specified by:
    
    isUrlRewriteSeoRulesEnabled in interface SettingsBean
  - isFileServletStatisticsEnabled
```
public boolean isFileServletStatisticsEnabled()
```
    Specified by:
    
    isFileServletStatisticsEnabled in interface SettingsBean
  - isUrlRewriteUseAbsoluteUrls
```
public boolean isUrlRewriteUseAbsoluteUrls()
```
    Specified by:
    
    isUrlRewriteUseAbsoluteUrls in interface SettingsBean
  - isUrlRewriteRemoveCmsPrefix
```
public boolean isUrlRewriteRemoveCmsPrefix()
```
    Specified by:
    
    isUrlRewriteRemoveCmsPrefix in interface SettingsBean
  - getImportMaxBatch
```
public int getImportMaxBatch()
```
    Specified by:
    
    getImportMaxBatch in interface SettingsBean
  - getMaxNameSize
```
public int getMaxNameSize()
```
    Specified by:
    
    getMaxNameSize in interface SettingsBean
  - isExpandImportedFilesOnDisk
```
public boolean isExpandImportedFilesOnDisk()
```
    Specified by:
    
    isExpandImportedFilesOnDisk in interface SettingsBean
  - getExpandImportedFilesOnDiskPath
```
public String getExpandImportedFilesOnDiskPath()
```
    Specified by:
    
    getExpandImportedFilesOnDiskPath in interface SettingsBean
  - getAccessManagerPathPermissionCacheMaxSize
```
public int getAccessManagerPathPermissionCacheMaxSize()
```
    Specified by:
    
    getAccessManagerPathPermissionCacheMaxSize in interface SettingsBean
  - getQueryApproxCountLimit
```
public int getQueryApproxCountLimit()
```
    Specified by:
    
    getQueryApproxCountLimit in interface SettingsBean
  - isReadOnlyMode
```
public boolean isReadOnlyMode()
```
    Returns true if this Jahia instance operates in "read-only" mode, i.e. access to the edit/studio/administration modes is not allowed.
    
    Specified by:
    
    isReadOnlyMode in interface SettingsBean
    
    Returns:
    
    true if this Jahia instance operates in "read-only" mode, i.e. access to the edit/studio/administration modes is not allowed; otherwise returns false
  - isFullReadOnlyMode
```
public boolean isFullReadOnlyMode()
```
    Returns true if this Jahia instance operates in "full-read-only" mode, i.e. access to the edit/studio/administration modes and saving in the JCR are not allowed.
    
    Specified by:
    
    isFullReadOnlyMode in interface SettingsBean
    
    Returns:
    
    true if this Jahia instance operates in "read-only" mode, i.e. access to the edit/studio/administration modes and saving in the JCR are not allowed.; otherwise returns false
  - setReadOnlyMode
```
public void setReadOnlyMode(boolean readOnlyMode)
```
    If set to true, access to the edit/studio/administration modes is disabled on this Jahia instance.
    
    Parameters:
    
    readOnlyMode - set to true to disable access to the edit/studio/administration modes on this Jahia instance
  - setDataSource
```
public void setDataSource(DataSource dataSource)
```
  - setClusterSettingsInitializer
```
public void setClusterSettingsInitializer(ClusterSettingsInitializer clusterSettingsInitializer)
```
  - getInternetExplorerCompatibility
```
public String getInternetExplorerCompatibility()
```
    Specified by:
    
    getInternetExplorerCompatibility in interface SettingsBean
  - isMavenExecutableSet
```
public boolean isMavenExecutableSet()
```
    Specified by:
    
    isMavenExecutableSet in interface SettingsBean
    
    Returns:
    
    true if maven is available
  - setMavenExecutableSet
```
public void setMavenExecutableSet(boolean isMavenExecutableSet)
```
  - getAuthorizedRedirectHosts
```
public String[] getAuthorizedRedirectHosts()
```
    Specified by:
    
    getAuthorizedRedirectHosts in interface SettingsBean
  - isUseWebsockets
```
public boolean isUseWebsockets()
```
    Specified by:
    
    isUseWebsockets in interface SettingsBean
  - setUseWebsockets
```
public void setUseWebsockets(boolean useWebsockets)
```
  - getAtmosphereAsyncSupport
```
public String getAtmosphereAsyncSupport()
```
    Specified by:
    
    getAtmosphereAsyncSupport in interface SettingsBean
  - setAtmosphereAsyncSupport
```
public void setAtmosphereAsyncSupport(String atmosphereAsyncSupport)
```
  - isAreaAutoActivated
```
public boolean isAreaAutoActivated()
```
    Specified by:
    
    isAreaAutoActivated in interface SettingsBean
  - getModuleSpringBeansWaitingTimeout
```
public int getModuleSpringBeansWaitingTimeout()
```
    Specified by:
    
    getModuleSpringBeansWaitingTimeout in interface SettingsBean
  - setModuleSpringBeansWaitingTimeout
```
public void setModuleSpringBeansWaitingTimeout(int moduleSpringBeansWaitingTimeout)
```
  - setLicenseFile
```
public void setLicenseFile(org.springframework.core.io.Resource licenseFile)
```
  - getStartupOptions
```
public StartupOptions getStartupOptions()
```
    Returns the startup options, which are set.
    
    Specified by:
    
    getStartupOptions in interface SettingsBean
    
    Returns:
    
    the startup options, which are set
  - isStartupOptionSet
```
public boolean isStartupOptionSet(String option)
```
    Checks if the specified startup option is set.
    
    Specified by:
    
    isStartupOptionSet in interface SettingsBean
    
    Parameters:
    
    option - the option key
    
    Returns:
    
    true if the specified option is set; false otherwise
  - setStartupOptionsMapping
```
public void setStartupOptionsMapping(Map<String,Set<String>> startupOptionsMapping)
```
  - getJahiaSiteImportScannerInterval
```
public int getJahiaSiteImportScannerInterval()
```
    Specified by:
    
    getJahiaSiteImportScannerInterval in interface SettingsBean
  - getStudioMaxDisplayableFileSize
```
public long getStudioMaxDisplayableFileSize()
```
    Specified by:
    
    getStudioMaxDisplayableFileSize in interface SettingsBean
  - getCookieAuthConfig
```
public CookieAuthConfig getCookieAuthConfig()
```
    Specified by:
    
    getCookieAuthConfig in interface SettingsBean
  - setCookieAuthConfig
```
public void setCookieAuthConfig(CookieAuthConfig cookieAuthConfig)
```

Class SettingsBean

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JAHIA_PROPERTIES_FILE_PATH

JAHIA_BACKUP_RESTORE_SYSTEM_PROP

Constructor Detail

SettingsBean

SettingsBean

Method Detail

getInstance

getErrorDir

getThreadDir

getHeapDir

getJahiaDatabaseScriptsPath

getJahiaJCRUserCountLimit

getAtmosphereHeartbeatFrequency

setJahiaJCRUserCountLimit

load

getModuleStartLevel

initPaths

isClusterActivated

getRepositoryHome

getRepositoryHomeResource

getDefaultLocale

getBoolean

getString

getString

getInt

getLong

getPropertyValue

lookupString

lookupBoolean

lookupLong

lookupInt

getPropertiesFile

getLicenseFileName

isUseRelativeSiteURLs

setUseRelativeSiteURLs

getJahiaWebAppsDeployerBaseURL

getDefaultLanguageCode

getBuildNumber

setBuildNumber

getServer

getServerHome

getJahiaEtcDiskPath

getJahiaVarDiskPath

getJahiaModulesDiskPath

getJahiaGeneratedResourcesDiskPath

getClassDiskPath

getJahiaFileUploadMaxSize

getJahiaHomeDiskPath

getJahiaImportsDiskPath

getJahiaExportsDiskPath

getCharacterEncoding

getPathResolver

setPathResolver

getTmpContentDiskPath

getModulesSourcesDiskPath

isProcessingServer

getSiteURLPortOverride

setSiteURLPortOverride

getMail_maxRegroupingOfPreviousException

setMail_maxRegroupingOfPreviousException

isDevelopmentMode

getSiteErrorEnabled

isConsiderDefaultJVMLocale

setConsiderDefaultJVMLocale

isConsiderPreferredLanguageAfterLogin

setConsiderPreferredLanguageAfterLogin

isPermanentMoveForVanityURL

isDumpErrorsToFiles

setDumpErrorsToFiles

getFileDumpMaxRegroupingOfPreviousException

getServerVersion

getServerDeployer

isMaintenanceMode

getSessionExpiryTime