public class SettingsBean extends Object implements org.springframework.web.context.ServletContextAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, ReadOnlyModeCapable
| Modifier and Type | Class and Description |
|---|---|
static interface |
SettingsBean.ClusterSettingsInitializer
An initializer of DX cluster related settings.
|
static class |
SettingsBean.ClusterSettingsInitializerDummy
Dummy cluster settings initializer that does nothing; particularly to be used by DX CE that does not support clustering.
|
| 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 and Description |
|---|
SettingsBean(PathResolver pathResolver,
Properties props,
List<String> licenseFileLocations) |
SettingsBean(PathResolver pathResolver,
String propertiesFilename,
String licenseFilename,
int buildNumber) |
| 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() |
String |
getAtmosphereAsyncSupport() |
String[] |
getAuthorizedRedirectHosts() |
int |
getBuildNumber()
Used to get the build number.
|
String |
getCharacterEncoding() |
String |
getClassDiskPath() |
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() |
String |
getInternetExplorerCompatibility() |
String |
getJahiaDatabaseScriptsPath() |
String |
getJahiaEtcDiskPath()
Used to get the jahiafiles /etc disk path.
|
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() |
int |
getMail_maxRegroupingOfPreviousException() |
int |
getMaxNameSize() |
int |
getModuleSpringBeansWaitingTimeout() |
String |
getModulesSourcesDiskPath() |
int |
getModuleStartLevel() |
String |
getOperatingMode() |
PathResolver |
getPathResolver() |
Properties |
getPropertiesFile()
Get the principal properties object.
|
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 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() |
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(int buildNumber) |
void |
setClusterSettingsInitializer(SettingsBean.ClusterSettingsInitializer clusterSettingsInitializer) |
void |
setConsiderDefaultJVMLocale(boolean considerDefaultJVMLocale) |
void |
setConsiderPreferredLanguageAfterLogin(boolean considerPreferredLanguageAfterLogin) |
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.
|
public static final String JAHIA_PROPERTIES_FILE_PATH
@Deprecated public static final String JAHIA_BACKUP_RESTORE_SYSTEM_PROP
isStartupOptionSet(String) insteadpublic SettingsBean(PathResolver pathResolver, String propertiesFilename, String licenseFilename, int buildNumber)
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.public SettingsBean(PathResolver pathResolver, Properties props, List<String> licenseFileLocations)
public static SettingsBean getInstance()
public static File getErrorDir()
public static File getThreadDir()
public static File getHeapDir()
public String getJahiaDatabaseScriptsPath()
public long getJahiaJCRUserCountLimit()
public void setJahiaJCRUserCountLimit(long jahiaJCRUserCountLimit)
public void load()
public int getModuleStartLevel()
public boolean isClusterActivated()
true if the clustering is activated.true if the clustering is activated; false otherwisepublic File getRepositoryHome() throws IOException
IOExceptionpublic org.springframework.core.io.Resource getRepositoryHomeResource()
throws IOException
IOExceptionpublic Locale getDefaultLocale()
public String lookupString(String key)
key parameter as a String result.key - the parameter key to lookupnull when the
parameter could not be found.public boolean lookupBoolean(String key)
key parameter as a boolean result.key - the parameter key to lookupfalse when the
parameter could not be found.public long lookupLong(String key)
key parameter as a long result.key - the parameter key to lookupLong.MIN_VALUE when the
parameter could not be found.public int lookupInt(String key)
key parameter as a long result.key - the parameter key to lookupLong.MIN_VALUE when the
parameter could not be found.public Properties getPropertiesFile()
public String getLicenseFileName()
public boolean isUseRelativeSiteURLs()
public void setUseRelativeSiteURLs(boolean val)
public String getJahiaWebAppsDeployerBaseURL()
public String getDefaultLanguageCode()
public int getBuildNumber()
public void setBuildNumber(int buildNumber)
public String getServer()
public String getServerHome()
public String getJahiaEtcDiskPath()
public String getJahiaVarDiskPath()
public String getJahiaModulesDiskPath()
public String getJahiaGeneratedResourcesDiskPath()
public String getClassDiskPath()
public long getJahiaFileUploadMaxSize()
@Deprecated public String getJahiaHomeDiskPath()
public String getJahiaImportsDiskPath()
public String getCharacterEncoding()
public PathResolver getPathResolver()
public void setPathResolver(PathResolver pathResolver)
public String getTmpContentDiskPath()
public String getModulesSourcesDiskPath()
public boolean isProcessingServer()
public int getSiteURLPortOverride()
public void setSiteURLPortOverride(int siteURLPortOverride)
public int getMail_maxRegroupingOfPreviousException()
public void setMail_maxRegroupingOfPreviousException(int mail_maxRegroupingOfPreviousException)
public boolean isDevelopmentMode()
public boolean getSiteErrorEnabled()
public boolean isConsiderDefaultJVMLocale()
public void setConsiderDefaultJVMLocale(boolean considerDefaultJVMLocale)
public boolean isConsiderPreferredLanguageAfterLogin()
public void setConsiderPreferredLanguageAfterLogin(boolean considerPreferredLanguageAfterLogin)
public boolean isPermanentMoveForVanityURL()
public boolean isDumpErrorsToFiles()
public void setDumpErrorsToFiles(boolean dumpErrorsToFiles)
public int getFileDumpMaxRegroupingOfPreviousException()
public String getServerVersion()
public org.jahia.configuration.deployers.ServerDeploymentInterface getServerDeployer()
public boolean isMaintenanceMode()
public int getSessionExpiryTime()
public void setSessionExpiryTime(int sessionExpiryTime)
public boolean isDisableJsessionIdParameter()
public void setDisableJsessionIdParameter(boolean disableJsessionIdParameter)
public String getJsessionIdParameterName()
public void setJsessionIdParameterName(String jsessionIdParameterName)
public String getGuestUserResourceKey()
public String getGuestUserResourceModuleName()
public String getGuestGroupResourceModuleName()
public void setGuestGroupResourceModuleName(String guestGroupResourceModuleName)
public String getGuestGroupResourceKey()
public void setGuestGroupResourceKey(String guestGroupResourceKey)
public static String convertContexted(String convert, PathResolver pathResolver)
convert - The string to convert.pathResolver - The path resolver used to get the real path.public static String convertWebContexted(String convert)
convert - the string to convertpublic void setServletContext(javax.servlet.ServletContext servletContext)
setServletContext in interface org.springframework.web.context.ServletContextAwarepublic javax.servlet.ServletContext getServletContext()
public String getTemplatesContext()
public org.springframework.core.io.Resource getLicenseFile()
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
throws org.springframework.beans.BeansException
setApplicationContext in interface org.springframework.context.ApplicationContextAwareorg.springframework.beans.BeansExceptionpublic void afterPropertiesSet()
throws Exception
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBeanExceptionpublic void switchReadOnlyMode(boolean enable)
ReadOnlyModeCapableswitchReadOnlyMode in interface ReadOnlyModeCapableenable - true in case the read-only mode should be enabled; false otherwisepublic int getReadOnlyModePriority()
ReadOnlyModeCapablegetReadOnlyModePriority in interface ReadOnlyModeCapablepublic String getOperatingMode()
public boolean isProductionMode()
public boolean isDistantPublicationServerMode()
public boolean isUseJstackForThreadDumps()
public boolean isUrlRewriteSeoRulesEnabled()
public boolean isFileServletStatisticsEnabled()
public boolean isUrlRewriteUseAbsoluteUrls()
public boolean isUrlRewriteRemoveCmsPrefix()
public int getImportMaxBatch()
public int getMaxNameSize()
public boolean isExpandImportedFilesOnDisk()
public String getExpandImportedFilesOnDiskPath()
public int getAccessManagerPathPermissionCacheMaxSize()
public int getQueryApproxCountLimit()
public boolean isReadOnlyMode()
true if this Jahia instance operates in "read-only" mode, i.e. access to the edit/studio/administration modes is
not allowed.true if this Jahia instance operates in "read-only" mode, i.e. access to the edit/studio/administration modes is
not allowed; otherwise returns falsepublic boolean isFullReadOnlyMode()
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.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 falsepublic void setReadOnlyMode(boolean readOnlyMode)
true, access to the edit/studio/administration modes is disabled on this Jahia instance.readOnlyMode - set to true to disable access to the edit/studio/administration modes on this Jahia instancepublic void setDataSource(DataSource dataSource)
public void setClusterSettingsInitializer(SettingsBean.ClusterSettingsInitializer clusterSettingsInitializer)
public String getInternetExplorerCompatibility()
public boolean isMavenExecutableSet()
public void setMavenExecutableSet(boolean isMavenExecutableSet)
public String[] getAuthorizedRedirectHosts()
public boolean isUseWebsockets()
public void setUseWebsockets(boolean useWebsockets)
public String getAtmosphereAsyncSupport()
public void setAtmosphereAsyncSupport(String atmosphereAsyncSupport)
public boolean isAreaAutoActivated()
public int getModuleSpringBeansWaitingTimeout()
public void setModuleSpringBeansWaitingTimeout(int moduleSpringBeansWaitingTimeout)
public void setLicenseFile(org.springframework.core.io.Resource licenseFile)
public StartupOptions getStartupOptions()
public boolean isStartupOptionSet(String option)
option - the option keytrue if the specified option is set; false otherwisepublic void setStartupOptionsMapping(Map<String,Set<String>> startupOptionsMapping)
public int getJahiaSiteImportScannerInterval()
public long getStudioMaxDisplayableFileSize()
Copyright © 2004–2020 Jahia Solutions Group SA. All rights reserved.