SettingsBean (Jahia Server Implementation 8.0.3.0 API)

All Known Implementing Classes:

SettingsBean
```
public interface SettingsBean
```
Commons settings

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getAccessManagerPathPermissionCacheMaxSize()`
`String`	`getAtmosphereAsyncSupport()`
`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()`
`String`	`getExpandImportedFilesOnDiskPath()`
`int`	`getFileDumpMaxRegroupingOfPreviousException()`
`String`	`getGuestGroupResourceKey()`
`String`	`getGuestGroupResourceModuleName()`
`String`	`getGuestUserResourceKey()`
`String`	`getGuestUserResourceModuleName()`
`int`	`getImportMaxBatch()`
`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()`
`String`	`getLicenseFileName()`
`long`	`getLong(String propertyName, long defaultValue)`
`int`	`getMaxNameSize()`
`int`	`getModuleSpringBeansWaitingTimeout()`
`String`	`getModulesSourcesDiskPath()`
`int`	`getModuleStartLevel()`
`String`	`getOperatingMode()`
`Properties`	`getPropertiesFile()` Get the principal properties object.
`String`	`getPropertyValue(String propertyName)`
`int`	`getQueryApproxCountLimit()`
`int`	`getReadOnlyModePriority()`
`File`	`getRepositoryHome()`
`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()`
`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.
`String`	`getTmpContentDiskPath()`
`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)`
`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`	`setSiteURLPortOverride(int siteURLPortOverride)`
`void`	`switchReadOnlyMode(boolean enable)`

- Method Detail
  - getJahiaDatabaseScriptsPath
```
String getJahiaDatabaseScriptsPath()
```
  - getJahiaJCRUserCountLimit
```
long getJahiaJCRUserCountLimit()
```
  - load
```
void load()
```
    This method load and convert properties from the jahia.properties file, and set some variables used by the SettingsBean class.
  - getModuleStartLevel
```
int getModuleStartLevel()
```
  - isClusterActivated
```
boolean isClusterActivated()
```
    Returns true if the clustering is activated.
    
    Returns:
    
    true if the clustering is activated; false otherwise
  - getRepositoryHome
```
File getRepositoryHome()
                throws IOException
```
    Throws:
    
    IOException
  - getDefaultLocale
```
Locale getDefaultLocale()
```
  - getBoolean
```
boolean getBoolean(String propertyName,
                   boolean defaultValue)
```
  - getString
```
String getString(String propertyName)
          throws NoSuchElementException
```
    Throws:
    
    NoSuchElementException
  - getString
```
String getString(String propertyName,
                 String defaultValue)
```
  - getInt
```
int getInt(String propertyName,
           int defaultValue)
```
  - getLong
```
long getLong(String propertyName,
             long defaultValue)
```
  - getPropertyValue
```
String getPropertyValue(String propertyName)
```
  - lookupString
```
String lookupString(String key)
```
    Looks up the specified key parameter as a String result.
    
    Parameters:
    
    key - the parameter key to lookup
    
    Returns:
    
    the requested parameter value. Returns null when the parameter could not be found.
  - lookupBoolean
```
boolean lookupBoolean(String key)
```
    Looks up the specified key parameter as a boolean result.
    
    Parameters:
    
    key - the parameter key to lookup
    
    Returns:
    
    the requested parameter value. Return false when the parameter could not be found.
  - lookupLong
```
long lookupLong(String key)
```
    Looks up the specified key parameter as a long result.
    
    Parameters:
    
    key - the parameter key to lookup
    
    Returns:
    
    the requested parameter value. Return Long.MIN_VALUE when the parameter could not be found.
  - lookupInt
```
int lookupInt(String key)
```
    Looks up the specified key parameter as a long result.
    
    Parameters:
    
    key - the parameter key to lookup
    
    Returns:
    
    the requested parameter value. Return Long.MIN_VALUE when the parameter could not be found.
  - getPropertiesFile
```
Properties getPropertiesFile()
```
    Get the principal properties object.
    
    Returns:
    
    Properties object containing all properties from jahia.properties file.
  - getLicenseFileName
```
String getLicenseFileName()
```
  - isUseRelativeSiteURLs
```
boolean isUseRelativeSiteURLs()
```
    Activation / deactivation of relative URLs, instead of absolute URLs, when generating URL to exit the Admin Menu for example
  - getJahiaWebAppsDeployerBaseURL
```
String getJahiaWebAppsDeployerBaseURL()
```
  - getDefaultLanguageCode
```
String getDefaultLanguageCode()
```
  - getBuildNumber
```
String getBuildNumber()
```
    Used to get the build number.
    
    Returns:
    
    The build number.
  - getServer
```
String getServer()
```
    Used to get the server name (tomcat, orion, etc).
    
    Returns:
    
    The server name.
  - getServerHome
```
String getServerHome()
```
    Used to get the server home filesystem disk path.
    
    Returns:
    
    The server home filesystem disk path.
  - getJahiaEtcDiskPath
```
String getJahiaEtcDiskPath()
```
    Used to get the jahiafiles /etc disk path.
    
    Returns:
    
    The jahiafiles /etc disk path.
  - getJahiaVarDiskPath
```
String getJahiaVarDiskPath()
```
    Used to get the jahiafiles /var disk path.
    
    Returns:
    
    The jahiafiles /var disk path.
  - getJahiaModulesDiskPath
```
String getJahiaModulesDiskPath()
```
    Used to get the shared templates disk path.
    
    Returns:
    
    The shared templates disk path.
  - getJahiaGeneratedResourcesDiskPath
```
String getJahiaGeneratedResourcesDiskPath()
```
    Returns:
    
    The generated resources disk path.
  - getClassDiskPath
```
String getClassDiskPath()
```
  - getJahiaFileUploadMaxSize
```
long getJahiaFileUploadMaxSize()
```
  - getJahiaHomeDiskPath
```
@Deprecated
String getJahiaHomeDiskPath()
```
    Deprecated. since 7.0.0.2
  - getJahiaImportsDiskPath
```
String getJahiaImportsDiskPath()
```
  - getJahiaExportsDiskPath
```
String getJahiaExportsDiskPath()
```
  - getCharacterEncoding
```
String getCharacterEncoding()
```
  - getTmpContentDiskPath
```
String getTmpContentDiskPath()
```
  - getModulesSourcesDiskPath
```
String getModulesSourcesDiskPath()
```
  - isProcessingServer
```
boolean isProcessingServer()
```
  - getSiteURLPortOverride
```
int getSiteURLPortOverride()
```
  - setSiteURLPortOverride
```
void setSiteURLPortOverride(int siteURLPortOverride)
```
  - isDevelopmentMode
```
boolean isDevelopmentMode()
```
  - getSiteErrorEnabled
```
boolean getSiteErrorEnabled()
```
    to get the Site errors page behavior
    
    Returns:
    
    a boolean
  - isConsiderDefaultJVMLocale
```
boolean isConsiderDefaultJVMLocale()
```
  - isConsiderPreferredLanguageAfterLogin
```
boolean isConsiderPreferredLanguageAfterLogin()
```
  - isPermanentMoveForVanityURL
```
boolean isPermanentMoveForVanityURL()
```
  - isDumpErrorsToFiles
```
boolean isDumpErrorsToFiles()
```
  - getFileDumpMaxRegroupingOfPreviousException
```
int getFileDumpMaxRegroupingOfPreviousException()
```
  - getServerVersion
```
String getServerVersion()
```
    Returns:
    
    the serverVersion
  - getServerDeployer
```
org.jahia.configuration.deployers.ServerDeploymentInterface getServerDeployer()
```
    Returns:
    
    the serverDeployer
  - isMaintenanceMode
```
boolean isMaintenanceMode()
```
  - getSessionExpiryTime
```
int getSessionExpiryTime()
```
  - isDisableJsessionIdParameter
```
boolean isDisableJsessionIdParameter()
```
  - getJsessionIdParameterName
```
String getJsessionIdParameterName()
```
  - getGuestUserResourceKey
```
String getGuestUserResourceKey()
```
  - getGuestUserResourceModuleName
```
String getGuestUserResourceModuleName()
```
  - getGuestGroupResourceModuleName
```
String getGuestGroupResourceModuleName()
```
  - getGuestGroupResourceKey
```
String getGuestGroupResourceKey()
```
  - getTemplatesContext
```
String getTemplatesContext()
```
    Used to get the templates context.
    
    Returns:
    
    The templates context.
  - switchReadOnlyMode
```
void switchReadOnlyMode(boolean enable)
```
  - getReadOnlyModePriority
```
int getReadOnlyModePriority()
```
  - getOperatingMode
```
String getOperatingMode()
```
  - isProductionMode
```
boolean isProductionMode()
```
  - isDistantPublicationServerMode
```
boolean isDistantPublicationServerMode()
```
  - isUseJstackForThreadDumps
```
boolean isUseJstackForThreadDumps()
```
  - isUrlRewriteSeoRulesEnabled
```
boolean isUrlRewriteSeoRulesEnabled()
```
  - isFileServletStatisticsEnabled
```
boolean isFileServletStatisticsEnabled()
```
  - isUrlRewriteUseAbsoluteUrls
```
boolean isUrlRewriteUseAbsoluteUrls()
```
  - isUrlRewriteRemoveCmsPrefix
```
boolean isUrlRewriteRemoveCmsPrefix()
```
  - getImportMaxBatch
```
int getImportMaxBatch()
```
  - getMaxNameSize
```
int getMaxNameSize()
```
  - isExpandImportedFilesOnDisk
```
boolean isExpandImportedFilesOnDisk()
```
  - getExpandImportedFilesOnDiskPath
```
String getExpandImportedFilesOnDiskPath()
```
  - getAccessManagerPathPermissionCacheMaxSize
```
int getAccessManagerPathPermissionCacheMaxSize()
```
  - getQueryApproxCountLimit
```
int getQueryApproxCountLimit()
```
  - isReadOnlyMode
```
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.
    
    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
```
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.
    
    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
  - getInternetExplorerCompatibility
```
String getInternetExplorerCompatibility()
```
  - isMavenExecutableSet
```
boolean isMavenExecutableSet()
```
  - getAuthorizedRedirectHosts
```
String[] getAuthorizedRedirectHosts()
```
  - isUseWebsockets
```
boolean isUseWebsockets()
```
  - getAtmosphereAsyncSupport
```
String getAtmosphereAsyncSupport()
```
  - isAreaAutoActivated
```
boolean isAreaAutoActivated()
```
  - getModuleSpringBeansWaitingTimeout
```
int getModuleSpringBeansWaitingTimeout()
```
  - isStartupOptionSet
```
boolean isStartupOptionSet(String option)
```
  - getStartupOptions
```
StartupOptions getStartupOptions()
```
    Returns the startup options, which are set.
    
    Returns:
    
    the startup options, which are set
  - getJahiaSiteImportScannerInterval
```
int getJahiaSiteImportScannerInterval()
```
  - getStudioMaxDisplayableFileSize
```
long getStudioMaxDisplayableFileSize()
```
  - getCookieAuthConfig
```
CookieAuthConfig getCookieAuthConfig()
```

Interface SettingsBean

Method Summary

Method Detail

getJahiaDatabaseScriptsPath

getJahiaJCRUserCountLimit

load

getModuleStartLevel

isClusterActivated

getRepositoryHome

getDefaultLocale

getBoolean

getString

getString

getInt

getLong

getPropertyValue

lookupString

lookupBoolean

lookupLong

lookupInt

getPropertiesFile

getLicenseFileName

isUseRelativeSiteURLs

getJahiaWebAppsDeployerBaseURL

getDefaultLanguageCode

getBuildNumber

getServer

getServerHome

getJahiaEtcDiskPath

getJahiaVarDiskPath

getJahiaModulesDiskPath

getJahiaGeneratedResourcesDiskPath

getClassDiskPath

getJahiaFileUploadMaxSize

getJahiaHomeDiskPath

getJahiaImportsDiskPath

getJahiaExportsDiskPath

getCharacterEncoding

getTmpContentDiskPath

getModulesSourcesDiskPath

isProcessingServer

getSiteURLPortOverride

setSiteURLPortOverride

isDevelopmentMode

getSiteErrorEnabled

isConsiderDefaultJVMLocale

isConsiderPreferredLanguageAfterLogin

isPermanentMoveForVanityURL

isDumpErrorsToFiles

getFileDumpMaxRegroupingOfPreviousException

getServerVersion

getServerDeployer

isMaintenanceMode

getSessionExpiryTime

isDisableJsessionIdParameter

getJsessionIdParameterName

getGuestUserResourceKey

getGuestUserResourceModuleName

getGuestGroupResourceModuleName

getGuestGroupResourceKey

getTemplatesContext

switchReadOnlyMode

getReadOnlyModePriority

getOperatingMode

isProductionMode

isDistantPublicationServerMode

isUseJstackForThreadDumps

isUrlRewriteSeoRulesEnabled

isFileServletStatisticsEnabled

isUrlRewriteUseAbsoluteUrls

isUrlRewriteRemoveCmsPrefix

getImportMaxBatch

getMaxNameSize

isExpandImportedFilesOnDisk

getExpandImportedFilesOnDiskPath

getAccessManagerPathPermissionCacheMaxSize

getQueryApproxCountLimit

isReadOnlyMode

isFullReadOnlyMode

getInternetExplorerCompatibility