Package org.opencms.configuration
Class CmsSystemConfiguration
- java.lang.Object
-
- org.opencms.configuration.A_CmsXmlConfiguration
-
- org.opencms.configuration.CmsSystemConfiguration
-
- All Implemented Interfaces:
I_CmsConfigurationParameterHandler
,I_CmsXmlConfiguration
public class CmsSystemConfiguration extends A_CmsXmlConfiguration
System master configuration class.- Since:
- 6.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CmsSystemConfiguration.ApiAuthorizationConfig
Data for creating API authorization handlers.static class
CmsSystemConfiguration.UserSessionMode
Enum for the user session mode.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
A_DELETED
The attribute name for the deleted node.static java.lang.String
A_ERROR
The "error" attribute.static java.lang.String
A_ERROR_PAGE
The "errorPage" attribute.static java.lang.String
A_EXCLUSIVE
The "exclusive" attribute.static java.lang.String
A_LOCALIZATION_MODE
The attribute name for the localization mode.static java.lang.String
A_MAXVISITED
The "maxvisited" attribute.static java.lang.String
A_OFFLINE
The "offline" attribute.static java.lang.String
A_ONLINE
The "online" attribute.static java.lang.String
A_POOLNAME
The "poolname" attribute.static java.lang.String
A_SECURITY
The "security" attribute.static java.lang.String
CONFIGURATION_DTD_NAME
The name of the DTD for this configuration.static CmsSystemConfiguration.UserSessionMode
DEFAULT_USER_SESSION_MODE
The default user session mode.static java.lang.String
DEFAULT_XML_FILE_NAME
The name of the default XML file for this configuration.static java.lang.String
N_ADE
The ade node name.static java.lang.String
N_ADE_CACHE
The ade-cache node name.static java.lang.String
N_API_AUTHORIZATION
Node name for a single API authorization handler.static java.lang.String
N_API_AUTHORIZATIONS
Node name for the group of API authorization handlers.static java.lang.String
N_AUTHORIZATIONHANDLER
The node name for the authorization handler.static java.lang.String
N_AVGCACHEBYTES
The node name for the avgcachebytes node.static java.lang.String
N_BROWSER_BASED
The node name for the browser-based node.static java.lang.String
N_CACHE_ENABLED
The node name for the cache-enabled node.static java.lang.String
N_CACHE_OFFLINE
The node name for the cache-offline node.static java.lang.String
N_CLASS
The node name for a job class.static java.lang.String
N_CONFIGURATION
The configuration node name.static java.lang.String
N_CONTAINERPAGES
The containerpages node name.static java.lang.String
N_CONTENT_NOTIFICATION
The duration after which responsible resource owners will be notified about out-dated content.static java.lang.String
N_DEFAULT_CONTENT_ENCODING
The node name for the defaultcontentencoding node.static java.lang.String
N_DEFAULTUSERS
The node name for the defaultusers expression.static java.lang.String
N_DETAIL_PAGE_HANDLER
The node name for the detail page handler.static java.lang.String
N_DEVICESELECTOR
The node name for the device selector node.static java.lang.String
N_DIGESTTYPE
The node name for the digest type.static java.lang.String
N_DISABLEMINUTES
The node name for the login account lock minutes.static java.lang.String
N_DOCUMENTS
The node name for the sitemap cache for documents.static java.lang.String
N_EMAIL_INTERVAL
The node name for the email-interval node.static java.lang.String
N_EMAIL_RECEIVER
The node name for the email-receiver node.static java.lang.String
N_EMAIL_SENDER
The node name for the email-sender node.static java.lang.String
N_ENABLESCURITY
The node name for the login security option enabled flag.static java.lang.String
N_ENCRYPTION
Node name for the encryption section.static java.lang.String
N_EVENTMANAGER
The node name for the request handler classes.static java.lang.String
N_EVENTS
The node name for the events node.static java.lang.String
N_FLEXCACHE
The node name for the flexcache node.static java.lang.String
N_FORM_BASED
The node name for the form-based node.static java.lang.String
N_GROUP_ADMINISTRATORS
The node name for the group-administrators node.static java.lang.String
N_GROUP_GUESTS
The node name for the group-guests node.static java.lang.String
N_GROUP_PROJECTMANAGERS
The node name for the group-projectmanagers node.static java.lang.String
N_GROUP_USERS
The node name for the group-users node.static java.lang.String
N_GROUPCONTAINERS
The groupcontainers node name.static java.lang.String
N_HISTORYSIZE
The node name for the publish "history-size" value.static java.lang.String
N_HTTP_AUTHENTICATION
The node name for the http-authentication node.static java.lang.String
N_I18N
The node name for the internationalization node.static java.lang.String
N_KEYGENERATOR
The name of the class to generate cache keys.static java.lang.String
N_LOCALE
The node name for individual locales.static java.lang.String
N_LOCALEHANDLER
The node name for the locale handler.static java.lang.String
N_LOCALESCONFIGURED
The node name for the configured locales.static java.lang.String
N_LOCALESDEFAULT
The node name for the default locale(s).static java.lang.String
N_LOG_INTERVAL
The node name for the log-interval node.static java.lang.String
N_LOGINMANAGER
The node name for the login manager.static java.lang.String
N_LOGOUT_URI
Node name for the logout URI.static java.lang.String
N_MAIL
The node name for the mail configuration.static java.lang.String
N_MAILFROM
The node name for the "mail from" node.static java.lang.String
N_MAILHOST
The node name for the "mail host" node.static java.lang.String
N_MAXBADATTEMPTS
The node name for the login manager bad attempt count.static java.lang.String
N_MAXCACHEBYTES
The node name for the maxcachebytes node.static java.lang.String
N_MAXENTRYBYTES
The node name for the maxentrybytes node.static java.lang.String
N_MAXKEYS
The node name for the maxkeys node.static java.lang.String
N_MAXUSAGE_PERCENT
The node name for the maxusagepercent node.static java.lang.String
N_MEMORYMONITOR
The node name for the memorymonitor node.static java.lang.String
N_NOTIFICATION_PROJECT
The duration after which responsibles will be notified about out-dated content.static java.lang.String
N_NOTIFICATION_TIME
The duration after which responsibles will be notified about out-dated content.static java.lang.String
N_PARAMETERS
The node name for the parameters.static java.lang.String
N_PASSWORD_CHANGE_INTERVAL
Node name for the password change interval.static java.lang.String
N_PASSWORDENCODING
The node name for the password encoding.static java.lang.String
N_PASSWORDHANDLER
The node name for the password handler.static java.lang.String
N_PERMISSIONHANDLER
The node name for the permission handler.static java.lang.String
N_PREVENTRESPONSEFLUSH
The node name for the prevent-response-flush node.static java.lang.String
N_PUBLISH_LIST_REMOVE_MODE
The node name for the publish list remove mode.static java.lang.String
N_PUBLISHMANAGER
The node name for the "publishhistory" section.static java.lang.String
N_QUEUEPERSISTANCE
The node name for the "publishhistory" section.static java.lang.String
N_QUEUESHUTDOWNTIME
The node name for the "publishhistory" section.static java.lang.String
N_RECEIVER
The node name for the memory email receiver.static java.lang.String
N_RELEASETAGSAFTEREND
The node name for the release-tags-after-end node.static java.lang.String
N_REQUESTERRORPAGEATTRIBUTE
The node name for the request-error-page-attribute node.static java.lang.String
N_REQUESTHANDLER
The node name for the request handler classes.static java.lang.String
N_REQUESTHANDLERS
The node name for the request handlers.static java.lang.String
N_RESOURCEINIT
The node name for the resource init classes.static java.lang.String
N_RESOURCEINITHANDLER
The node name for the resource init classes.static java.lang.String
N_RESTRICT_DETAIL_CONTENTS
Node name for the restrict-detail-contents option.static java.lang.String
N_RESULTCACHE
the result cache node.static java.lang.String
N_RUNTIMECLASSES
The node name for the runtime info.static java.lang.String
N_RUNTIMEINFO
The node name for the runtime info factory.static java.lang.String
N_RUNTIMEPROPERTIES
The node name for the runtime properties node.static java.lang.String
N_SAX_IMPL_SYSTEM_PROPERTIES
The node name for the sax-impl-system-properties node.static java.lang.String
N_SERVLETCONTAINERSETTINGS
The node name for the servlet container settings.static java.lang.String
N_SESSION_STORAGEPROVIDER
The node name for the session-storageprovider node.static java.lang.String
N_SITEMAP
The sitemap node name.static java.lang.String
N_SITEMAP_CACHE
The sitemap-cache node name.static java.lang.String
N_SIZE_ACLS
The size of the memory monitor's cache for ACLS.static java.lang.String
N_SIZE_CONTAINERPAGE_OFFLINE
The size of the memory monitor's cache for offline container pages.static java.lang.String
N_SIZE_CONTAINERPAGE_ONLINE
The size of the memory monitor's cache for online container pages.static java.lang.String
N_SIZE_GROUPS
The size of the memory monitor's cache for groups.static java.lang.String
N_SIZE_ORGUNITS
The size of the memory monitor's cache for organizational units.static java.lang.String
N_SIZE_PERMISSIONS
The size of the memory monitor's cache for permission checks.static java.lang.String
N_SIZE_PROJECTRESOURCES
The size of the memory monitor's cache for project resources.static java.lang.String
N_SIZE_PROJECTS
The size of the memory monitor's cache for projects.static java.lang.String
N_SIZE_PROPERTIES
The size of the memory monitor's cache for properties.static java.lang.String
N_SIZE_PROPERTYLISTS
The size of the memory monitor's cache for property lists.static java.lang.String
N_SIZE_RESOURCELISTS
The size of the memory monitor's cache for lists of resources.static java.lang.String
N_SIZE_RESOURCES
The size of the memory monitor's cache for resources.static java.lang.String
N_SIZE_ROLES
The size of the memory monitor's cache for roles.static java.lang.String
N_SIZE_USERGROUPS
The size of the memory monitor's cache for user/group relations.static java.lang.String
N_SIZE_USERS
The size of the memory monitor's cache for users.static java.lang.String
N_SUBSCRIPTIONMANAGER
The subscriptionmanager node name.static java.lang.String
N_SYSTEM
The main system configuration node name.static java.lang.String
N_TEXT_ENCRYPTION
Node name for declaring a single text encryption.static java.lang.String
N_TIMEZONE
The node name for the time zone configuration.static java.lang.String
N_TOKEN_LIFETIME
Node name for the authorization token lifetime.static java.lang.String
N_USER_ADMIN
The node name for the user-admin node.static java.lang.String
N_USER_DATA_CHECK_INTERVAL
Node name for the user data check interval.static java.lang.String
N_USER_DELETEDRESOURCE
The node name for the user-deletedresource node.static java.lang.String
N_USER_EXPORT
The node name for the user-export node.static java.lang.String
N_USER_GUEST
The node name for the user-guest node.static java.lang.String
N_VALIDATIONHANDLER
The node name for the validation handler.static java.lang.String
N_VERSIONHISTORY
The node name for the version history.static java.lang.String
N_WARNING_INTERVAL
The node name for the warning-interval node.static java.lang.String
N_WEBSERVERSCRIPTING
The node name which indicates if apache should be configurable in sitemanager.static java.lang.String
N_WEBSERVERSCRIPTING_CONFIGTEMPLATE
static java.lang.String
N_WEBSERVERSCRIPTING_FILENAMEPREFIX
static java.lang.String
N_WEBSERVERSCRIPTING_LOGGINGDIR
static java.lang.String
N_WEBSERVERSCRIPTING_SECURETEMPLATE
static java.lang.String
N_WEBSERVERSCRIPTING_TARGETPATH
static java.lang.String
N_WEBSERVERSCRIPTING_WEBSERVERSCRIPT
static java.lang.String
N_WORKFLOW
The node name for the workflow configuration.-
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
-
Fields inherited from interface org.opencms.configuration.I_CmsXmlConfiguration
A_ALIAS, A_CLASS, A_COUNT, A_DEFAULT, A_DESTINATION, A_ENABLED, A_FROM, A_HANDLER, A_ICON, A_ID, A_KEY, A_MODE, A_NAME, A_ORDER, A_PASSWORD, A_PORT, A_PROTOCOL, A_SUFFIX, A_TO, A_TYPE, A_URI, A_USER, A_VALUE, N_EXPORTPOINT, N_EXPORTPOINTS, N_NAME, N_PARAM, N_PROPERTY, N_RESOURCE, N_SITE, N_VALUE
-
-
Constructor Summary
Constructors Constructor Description CmsSystemConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAdeParameter(java.lang.String name, java.lang.String value)
Adds an ADE configuration parameter.protected void
addApiAuthorization(CmsSystemConfiguration.ApiAuthorizationConfig config)
Adds a new authorization configuration.void
addAuthorizationHandlerParam(java.lang.String name, java.lang.String value)
Adds a parameter for the authorization handler.void
addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)
Adds a configuration parameter to this parameter configurable class instance.void
addEventManager(java.lang.String clazz)
Adds the event manager class.void
addRequestHandler(java.lang.String clazz, CmsParameterConfiguration params)
Adds a new instance of a request handler class.void
addResourceInitHandler(java.lang.String clazz, CmsParameterConfiguration params)
Adds a new instance of a resource init handler class.void
addXmlDigesterRules(org.apache.commons.digester3.Digester digester)
Digests an XML node and creates an instance of this configurable class.org.dom4j.Element
generateXml(org.dom4j.Element parent)
Generates the XML element for this configurable class.CmsADECacheSettings
getAdeCacheSettings()
Returns the settings of the ADE cache.java.lang.String
getAdeConfiguration()
Returns the ade configuration class name.java.util.Map<java.lang.String,java.lang.String>
getAdeParameters()
Gets the ADE configuration parameters.java.util.Map<java.lang.String,I_CmsApiAuthorizationHandler>
getApiAuthorizations()
Gets the map of API authorization handlers (with names as keys).I_CmsAuthorizationHandler
getAuthorizationHandler()
Returns an instance of the configured authorization handler.CmsCacheSettings
getCacheSettings()
Returns the settings of the memory monitor.CmsDefaultUsers
getCmsDefaultUsers()
Returns the default users.CmsFlexCacheConfiguration
getCmsFlexCacheConfiguration()
Returns the flexCacheConfiguration.CmsMemoryMonitorConfiguration
getCmsMemoryMonitorConfiguration()
Returns the memory monitor configuration.I_CmsCredentialsResolver
getCredentialsResolver()
Gets the credentials resolver.java.lang.String
getCredentialsResolverClass()
Gets the configured credentials resolver class name (null if no class is explicity configured).java.lang.String
getDefaultContentEncoding()
Returns the defaultContentEncoding.I_CmsDetailPageHandler
getDetailPageHandler()
Gets the detail page handler.java.lang.String
getDtdFilename()
Returns the name of the DTD file for this XML configuration, e.g.CmsEventManager
getEventManager()
Returns the configured OpenCms event manager instance.int
getHistoryVersions()
Returns the maximum number of versions that are kept per resource in the VFS version history.int
getHistoryVersionsAfterDeletion()
Returns the maximum number of versions that are kept in the VFS version history for deleted resources.CmsHttpAuthenticationSettings
getHttpAuthenticationSettings()
Returns the HTTP authentication settings.CmsLetsEncryptConfiguration
getLetsEncryptConfig()
Gets the LetsEncrypt configuration.CmsLocaleManager
getLocaleManager()
Returns the configured locale manager for multi language support.CmsLoginManager
getLoginManager()
Returns the configured login manager.CmsMailSettings
getMailSettings()
Returns the configured mail settings.java.lang.String
getNotificationProject()
Returns the project in which timestamps for the content notification are read.int
getNotificationTime()
Returns the duration after which responsibles will be notified about out-dated content (in days).I_CmsPasswordHandler
getPasswordHandler()
Returns the configured password handler.java.lang.String
getPermissionHandler()
Returns the permission Handler class name.CmsPublishManager.PublishListRemoveMode
getPublishListRemoveMode()
Returns the configured publish list remove mode, or a default value if there is no configured value or an erroneous configured value.java.lang.String
getPublishListRemoveModeStr()
Returns the configured publish list remove mode as a string, or null if no publish list remove mode has been configured.CmsPublishManager
getPublishManager()
Returns the configured publish manager.java.util.List<I_CmsRequestHandler>
getRequestHandlers()
Returns the list of instantiated request handler classes.java.util.List<I_CmsResourceInit>
getResourceInitHandlers()
Returns the list of instantiated resource init handler classes.I_CmsDbContextFactory
getRuntimeInfoFactory()
Returns the runtime info factory instance.java.util.Map<java.lang.String,java.lang.String>
getRuntimeProperties()
Returns the runtime Properties.I_CmsSessionStorageProvider
getSessionStorageProvider()
Returns an instance of the configured session storage provider.CmsRemoteShellConfiguration
getShellServerOptions()
Returns the shell server options.CmsSubscriptionManager
getSubscriptionManager()
Returns the configured subscription manager.int
getTempFileProjectId()
Returns temporary file project id.java.util.Map<java.lang.String,I_CmsTextEncryption>
getTextEncryptions()
Gets the map of text encryptions.CmsTwoFactorAuthenticationConfig
getTwoFactorAuthenticationConfig()
Gets the two-factor authentication configuration.CmsUserDataRequestManager
getUserDataRequestManager()
Gets the user data request manager.CmsSystemConfiguration.UserSessionMode
getUserSessionMode(boolean useDefault)
Gets the user session mode.I_CmsValidationHandler
getValidationHandler()
Returns an instance of the configured validation handler.I_CmsWorkflowManager
getWorkflowManager()
Gets the configured workflow manager instance.void
initializeFinished()
Will be called when configuration of this object is finished.protected void
initMembers()
Initializes member variables.boolean
isHistoryEnabled()
Returns if the VFS version history is enabled.boolean
isRestrictDetailContents()
Returns true if detail contents are restricted to detail pages from the same site.void
setAdeCacheSettings(CmsADECacheSettings settings)
Sets the cache settings for ADE.void
setAdeConfiguration(java.lang.String className)
Sets the ADE configuration class name.void
setAuthorizationHandler(java.lang.String authorizationHandlerClass)
Sets the authorization handler.void
setCacheSettings(CmsCacheSettings settings)
Sets the settings of the memory monitor.void
setCmsDefaultUsers(java.lang.String userAdmin, java.lang.String userGuest, java.lang.String userExport, java.lang.String userDeletedResource, java.lang.String groupAdministrators, java.lang.String groupUsers, java.lang.String groupGuests)
Sets the CmsDefaultUsers.void
setCmsFlexCacheConfiguration(CmsFlexCacheConfiguration flexCacheConfiguration)
Sets the flexCacheConfiguration.void
setCmsMemoryMonitorConfiguration(CmsMemoryMonitorConfiguration cmsMemoryMonitorConfiguration)
Sets the cmsMemoryMonitorConfiguration.void
setCredentialsResolver(java.lang.String className)
Sets the credentials resolver class.void
setDefaultContentEncoding(java.lang.String defaultContentEncoding)
Sets the defaultContentEncoding.void
setDetailPageHandler(I_CmsDetailPageHandler handler)
Sets the detail page handler.void
setHistorySettings(java.lang.String historyEnabled, java.lang.String historyVersions, java.lang.String historyVersionsAfterDeletion)
VFS version history settings are set here.void
setHttpAuthenticationSettings(CmsHttpAuthenticationSettings httpAuthenticationSettings)
Sets the HTTP authentication settings.void
setLetsEncryptConfig(CmsLetsEncryptConfiguration letsEncryptConfig)
Sets the LetsEncrypt configuration.void
setLocaleManager(CmsLocaleManager localeManager)
Sets the locale manager for multi language support.void
setLoginManager(java.lang.String disableMinutesStr, java.lang.String maxBadAttemptsStr, java.lang.String enableSecurityStr, java.lang.String tokenLifetime, java.lang.String maxInactive, java.lang.String passwordChangeInterval, java.lang.String userDataCheckInterval, java.lang.String requireOrgUnitStr, java.lang.String logoutUri)
Sets the configured login manager.void
setMailSettings(CmsMailSettings mailSettings)
Sets the mail settings.void
setNotificationProject(java.lang.String notificationProject)
Sets the project in which timestamps for the content notification are read.void
setNotificationTime(java.lang.String notificationTime)
Sets the duration after which responsibles will be notified about out-dated content (in days).void
setPasswordHandler(I_CmsPasswordHandler passwordHandler)
Sets the password handler class.void
setPermissionHandler(java.lang.String permissionHandler)
Sets the permission Handler class name.void
setPreventResponseFlush(java.lang.String configValue)
Sets the servlet container specific setting.void
setPublishListRemoveMode(java.lang.String removeMode)
Sets the publish list remove mode.void
setPublishManager(CmsPublishManager publishManager)
Sets the publish manager.void
setReleaseTagsAfterEnd(java.lang.String configValue)
Sets the servlet container specific setting.void
setRequestErrorPageAttribute(java.lang.String configValue)
Sets the servlet container specific setting.void
setRestrictDetailContents(java.lang.String restrictDetailContents)
Sets the 'restrict detail contents' option.void
setRuntimeInfoFactory(java.lang.String className)
Sets the runtime info factory.void
setServletContainerSettingsMode(java.lang.String configValue)
Sets the servlet container settings configuration mode.void
setSessionStorageProvider(java.lang.String sessionStorageProviderClass)
Sets the session storage provider.void
setShellServerOptions(java.lang.String enabled, java.lang.String portStr)
Sets the shell server options from the confriguration.void
setSubscriptionManager(CmsSubscriptionManager subscriptionManager)
Sets the subscription manager.void
setTempFileProjectId(java.lang.String tempFileProjectId)
Sets the temporary file project id.void
setUserDataRequestManager(CmsUserDataRequestManager manager)
Sets the user data request manager.void
setUserSessionMode(java.lang.String userSessionMode)
Sets the user session mode.void
setUseSaxImplSystemProperties(java.lang.String enabled)
Sets if the SAX parser implementation classes should be stored in system properties to improve the unmarshalling performance.void
setValidationHandler(java.lang.String validationHandlerClass)
Sets the validation handler.void
setWorkflowManager(I_CmsWorkflowManager workflowManager)
Sets the configured workflow manager instance.boolean
useSaxImplSystemProperties()
Returns whether the SAX parser implementation classes should be stored in system properties to improve the unmarshalling performance.-
Methods inherited from class org.opencms.configuration.A_CmsXmlConfiguration
getConfiguration, getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName, initConfiguration, setXmlFileName
-
-
-
-
Field Detail
-
A_DELETED
public static final java.lang.String A_DELETED
The attribute name for the deleted node.- See Also:
- Constant Field Values
-
A_ERROR
public static final java.lang.String A_ERROR
The "error" attribute.- See Also:
- Constant Field Values
-
A_ERROR_PAGE
public static final java.lang.String A_ERROR_PAGE
The "errorPage" attribute.- See Also:
- Constant Field Values
-
A_EXCLUSIVE
public static final java.lang.String A_EXCLUSIVE
The "exclusive" attribute.- See Also:
- Constant Field Values
-
A_LOCALIZATION_MODE
public static final java.lang.String A_LOCALIZATION_MODE
The attribute name for the localization mode.- See Also:
- Constant Field Values
-
A_MAXVISITED
public static final java.lang.String A_MAXVISITED
The "maxvisited" attribute.- See Also:
- Constant Field Values
-
A_OFFLINE
public static final java.lang.String A_OFFLINE
The "offline" attribute.- See Also:
- Constant Field Values
-
A_ONLINE
public static final java.lang.String A_ONLINE
The "online" attribute.- See Also:
- Constant Field Values
-
A_POOLNAME
public static final java.lang.String A_POOLNAME
The "poolname" attribute.- See Also:
- Constant Field Values
-
A_SECURITY
public static final java.lang.String A_SECURITY
The "security" attribute.- See Also:
- Constant Field Values
-
CONFIGURATION_DTD_NAME
public static final java.lang.String CONFIGURATION_DTD_NAME
The name of the DTD for this configuration.- See Also:
- Constant Field Values
-
DEFAULT_USER_SESSION_MODE
public static final CmsSystemConfiguration.UserSessionMode DEFAULT_USER_SESSION_MODE
The default user session mode.
-
DEFAULT_XML_FILE_NAME
public static final java.lang.String DEFAULT_XML_FILE_NAME
The name of the default XML file for this configuration.- See Also:
- Constant Field Values
-
N_ADE
public static final java.lang.String N_ADE
The ade node name.- See Also:
- Constant Field Values
-
N_ADE_CACHE
public static final java.lang.String N_ADE_CACHE
The ade-cache node name.- See Also:
- Constant Field Values
-
N_API_AUTHORIZATION
public static final java.lang.String N_API_AUTHORIZATION
Node name for a single API authorization handler.- See Also:
- Constant Field Values
-
N_API_AUTHORIZATIONS
public static final java.lang.String N_API_AUTHORIZATIONS
Node name for the group of API authorization handlers.- See Also:
- Constant Field Values
-
N_AUTHORIZATIONHANDLER
public static final java.lang.String N_AUTHORIZATIONHANDLER
The node name for the authorization handler.- See Also:
- Constant Field Values
-
N_AVGCACHEBYTES
public static final java.lang.String N_AVGCACHEBYTES
The node name for the avgcachebytes node.- See Also:
- Constant Field Values
-
N_BROWSER_BASED
public static final java.lang.String N_BROWSER_BASED
The node name for the browser-based node.- See Also:
- Constant Field Values
-
N_CACHE_ENABLED
public static final java.lang.String N_CACHE_ENABLED
The node name for the cache-enabled node.- See Also:
- Constant Field Values
-
N_CACHE_OFFLINE
public static final java.lang.String N_CACHE_OFFLINE
The node name for the cache-offline node.- See Also:
- Constant Field Values
-
N_CLASS
public static final java.lang.String N_CLASS
The node name for a job class.- See Also:
- Constant Field Values
-
N_CONFIGURATION
public static final java.lang.String N_CONFIGURATION
The configuration node name.- See Also:
- Constant Field Values
-
N_CONTAINERPAGES
public static final java.lang.String N_CONTAINERPAGES
The containerpages node name.- See Also:
- Constant Field Values
-
N_CONTENT_NOTIFICATION
public static final java.lang.String N_CONTENT_NOTIFICATION
The duration after which responsible resource owners will be notified about out-dated content.- See Also:
- Constant Field Values
-
N_DEFAULT_CONTENT_ENCODING
public static final java.lang.String N_DEFAULT_CONTENT_ENCODING
The node name for the defaultcontentencoding node.- See Also:
- Constant Field Values
-
N_DEFAULTUSERS
public static final java.lang.String N_DEFAULTUSERS
The node name for the defaultusers expression.- See Also:
- Constant Field Values
-
N_DETAIL_PAGE_HANDLER
public static final java.lang.String N_DETAIL_PAGE_HANDLER
The node name for the detail page handler.- See Also:
- Constant Field Values
-
N_DEVICESELECTOR
public static final java.lang.String N_DEVICESELECTOR
The node name for the device selector node.- See Also:
- Constant Field Values
-
N_DIGESTTYPE
public static final java.lang.String N_DIGESTTYPE
The node name for the digest type.- See Also:
- Constant Field Values
-
N_DISABLEMINUTES
public static final java.lang.String N_DISABLEMINUTES
The node name for the login account lock minutes.- See Also:
- Constant Field Values
-
N_DOCUMENTS
public static final java.lang.String N_DOCUMENTS
The node name for the sitemap cache for documents.- See Also:
- Constant Field Values
-
N_EMAIL_INTERVAL
public static final java.lang.String N_EMAIL_INTERVAL
The node name for the email-interval node.- See Also:
- Constant Field Values
-
N_EMAIL_RECEIVER
public static final java.lang.String N_EMAIL_RECEIVER
The node name for the email-receiver node.- See Also:
- Constant Field Values
-
N_EMAIL_SENDER
public static final java.lang.String N_EMAIL_SENDER
The node name for the email-sender node.- See Also:
- Constant Field Values
-
N_ENABLESCURITY
public static final java.lang.String N_ENABLESCURITY
The node name for the login security option enabled flag.- See Also:
- Constant Field Values
-
N_ENCRYPTION
public static final java.lang.String N_ENCRYPTION
Node name for the encryption section.- See Also:
- Constant Field Values
-
N_EVENTMANAGER
public static final java.lang.String N_EVENTMANAGER
The node name for the request handler classes.- See Also:
- Constant Field Values
-
N_EVENTS
public static final java.lang.String N_EVENTS
The node name for the events node.- See Also:
- Constant Field Values
-
N_FLEXCACHE
public static final java.lang.String N_FLEXCACHE
The node name for the flexcache node.- See Also:
- Constant Field Values
-
N_FORM_BASED
public static final java.lang.String N_FORM_BASED
The node name for the form-based node.- See Also:
- Constant Field Values
-
N_GROUP_ADMINISTRATORS
public static final java.lang.String N_GROUP_ADMINISTRATORS
The node name for the group-administrators node.- See Also:
- Constant Field Values
-
N_GROUP_GUESTS
public static final java.lang.String N_GROUP_GUESTS
The node name for the group-guests node.- See Also:
- Constant Field Values
-
N_GROUP_PROJECTMANAGERS
public static final java.lang.String N_GROUP_PROJECTMANAGERS
The node name for the group-projectmanagers node.- See Also:
- Constant Field Values
-
N_GROUP_USERS
public static final java.lang.String N_GROUP_USERS
The node name for the group-users node.- See Also:
- Constant Field Values
-
N_GROUPCONTAINERS
public static final java.lang.String N_GROUPCONTAINERS
The groupcontainers node name.- See Also:
- Constant Field Values
-
N_HISTORYSIZE
public static final java.lang.String N_HISTORYSIZE
The node name for the publish "history-size" value.- See Also:
- Constant Field Values
-
N_HTTP_AUTHENTICATION
public static final java.lang.String N_HTTP_AUTHENTICATION
The node name for the http-authentication node.- See Also:
- Constant Field Values
-
N_I18N
public static final java.lang.String N_I18N
The node name for the internationalization node.- See Also:
- Constant Field Values
-
N_KEYGENERATOR
public static final java.lang.String N_KEYGENERATOR
The name of the class to generate cache keys.- See Also:
- Constant Field Values
-
N_LOCALE
public static final java.lang.String N_LOCALE
The node name for individual locales.- See Also:
- Constant Field Values
-
N_LOCALEHANDLER
public static final java.lang.String N_LOCALEHANDLER
The node name for the locale handler.- See Also:
- Constant Field Values
-
N_LOCALESCONFIGURED
public static final java.lang.String N_LOCALESCONFIGURED
The node name for the configured locales.- See Also:
- Constant Field Values
-
N_LOCALESDEFAULT
public static final java.lang.String N_LOCALESDEFAULT
The node name for the default locale(s).- See Also:
- Constant Field Values
-
N_LOG_INTERVAL
public static final java.lang.String N_LOG_INTERVAL
The node name for the log-interval node.- See Also:
- Constant Field Values
-
N_LOGINMANAGER
public static final java.lang.String N_LOGINMANAGER
The node name for the login manager.- See Also:
- Constant Field Values
-
N_LOGOUT_URI
public static final java.lang.String N_LOGOUT_URI
Node name for the logout URI.- See Also:
- Constant Field Values
-
N_MAIL
public static final java.lang.String N_MAIL
The node name for the mail configuration.- See Also:
- Constant Field Values
-
N_MAILFROM
public static final java.lang.String N_MAILFROM
The node name for the "mail from" node.- See Also:
- Constant Field Values
-
N_MAILHOST
public static final java.lang.String N_MAILHOST
The node name for the "mail host" node.- See Also:
- Constant Field Values
-
N_MAXBADATTEMPTS
public static final java.lang.String N_MAXBADATTEMPTS
The node name for the login manager bad attempt count.- See Also:
- Constant Field Values
-
N_MAXCACHEBYTES
public static final java.lang.String N_MAXCACHEBYTES
The node name for the maxcachebytes node.- See Also:
- Constant Field Values
-
N_MAXENTRYBYTES
public static final java.lang.String N_MAXENTRYBYTES
The node name for the maxentrybytes node.- See Also:
- Constant Field Values
-
N_MAXKEYS
public static final java.lang.String N_MAXKEYS
The node name for the maxkeys node.- See Also:
- Constant Field Values
-
N_MAXUSAGE_PERCENT
public static final java.lang.String N_MAXUSAGE_PERCENT
The node name for the maxusagepercent node.- See Also:
- Constant Field Values
-
N_MEMORYMONITOR
public static final java.lang.String N_MEMORYMONITOR
The node name for the memorymonitor node.- See Also:
- Constant Field Values
-
N_NOTIFICATION_PROJECT
public static final java.lang.String N_NOTIFICATION_PROJECT
The duration after which responsibles will be notified about out-dated content.- See Also:
- Constant Field Values
-
N_NOTIFICATION_TIME
public static final java.lang.String N_NOTIFICATION_TIME
The duration after which responsibles will be notified about out-dated content.- See Also:
- Constant Field Values
-
N_PARAMETERS
public static final java.lang.String N_PARAMETERS
The node name for the parameters.- See Also:
- Constant Field Values
-
N_PASSWORD_CHANGE_INTERVAL
public static final java.lang.String N_PASSWORD_CHANGE_INTERVAL
Node name for the password change interval.- See Also:
- Constant Field Values
-
N_PASSWORDENCODING
public static final java.lang.String N_PASSWORDENCODING
The node name for the password encoding.- See Also:
- Constant Field Values
-
N_PASSWORDHANDLER
public static final java.lang.String N_PASSWORDHANDLER
The node name for the password handler.- See Also:
- Constant Field Values
-
N_PERMISSIONHANDLER
public static final java.lang.String N_PERMISSIONHANDLER
The node name for the permission handler.- See Also:
- Constant Field Values
-
N_PREVENTRESPONSEFLUSH
public static final java.lang.String N_PREVENTRESPONSEFLUSH
The node name for the prevent-response-flush node.- See Also:
- Constant Field Values
-
N_PUBLISH_LIST_REMOVE_MODE
public static final java.lang.String N_PUBLISH_LIST_REMOVE_MODE
The node name for the publish list remove mode.- See Also:
- Constant Field Values
-
N_PUBLISHMANAGER
public static final java.lang.String N_PUBLISHMANAGER
The node name for the "publishhistory" section.- See Also:
- Constant Field Values
-
N_QUEUEPERSISTANCE
public static final java.lang.String N_QUEUEPERSISTANCE
The node name for the "publishhistory" section.- See Also:
- Constant Field Values
-
N_QUEUESHUTDOWNTIME
public static final java.lang.String N_QUEUESHUTDOWNTIME
The node name for the "publishhistory" section.- See Also:
- Constant Field Values
-
N_RECEIVER
public static final java.lang.String N_RECEIVER
The node name for the memory email receiver.- See Also:
- Constant Field Values
-
N_RELEASETAGSAFTEREND
public static final java.lang.String N_RELEASETAGSAFTEREND
The node name for the release-tags-after-end node.- See Also:
- Constant Field Values
-
N_REQUESTERRORPAGEATTRIBUTE
public static final java.lang.String N_REQUESTERRORPAGEATTRIBUTE
The node name for the request-error-page-attribute node.- See Also:
- Constant Field Values
-
N_REQUESTHANDLER
public static final java.lang.String N_REQUESTHANDLER
The node name for the request handler classes.- See Also:
- Constant Field Values
-
N_REQUESTHANDLERS
public static final java.lang.String N_REQUESTHANDLERS
The node name for the request handlers.- See Also:
- Constant Field Values
-
N_RESOURCEINIT
public static final java.lang.String N_RESOURCEINIT
The node name for the resource init classes.- See Also:
- Constant Field Values
-
N_RESOURCEINITHANDLER
public static final java.lang.String N_RESOURCEINITHANDLER
The node name for the resource init classes.- See Also:
- Constant Field Values
-
N_RESTRICT_DETAIL_CONTENTS
public static final java.lang.String N_RESTRICT_DETAIL_CONTENTS
Node name for the restrict-detail-contents option.- See Also:
- Constant Field Values
-
N_RESULTCACHE
public static final java.lang.String N_RESULTCACHE
the result cache node.- See Also:
- Constant Field Values
-
N_RUNTIMECLASSES
public static final java.lang.String N_RUNTIMECLASSES
The node name for the runtime info.- See Also:
- Constant Field Values
-
N_RUNTIMEINFO
public static final java.lang.String N_RUNTIMEINFO
The node name for the runtime info factory.- See Also:
- Constant Field Values
-
N_RUNTIMEPROPERTIES
public static final java.lang.String N_RUNTIMEPROPERTIES
The node name for the runtime properties node.- See Also:
- Constant Field Values
-
N_SAX_IMPL_SYSTEM_PROPERTIES
public static final java.lang.String N_SAX_IMPL_SYSTEM_PROPERTIES
The node name for the sax-impl-system-properties node.- See Also:
- Constant Field Values
-
N_SERVLETCONTAINERSETTINGS
public static final java.lang.String N_SERVLETCONTAINERSETTINGS
The node name for the servlet container settings.- See Also:
- Constant Field Values
-
N_SESSION_STORAGEPROVIDER
public static final java.lang.String N_SESSION_STORAGEPROVIDER
The node name for the session-storageprovider node.- See Also:
- Constant Field Values
-
N_SITEMAP
public static final java.lang.String N_SITEMAP
The sitemap node name.- See Also:
- Constant Field Values
-
N_SITEMAP_CACHE
public static final java.lang.String N_SITEMAP_CACHE
The sitemap-cache node name.- See Also:
- Constant Field Values
-
N_SIZE_ACLS
public static final java.lang.String N_SIZE_ACLS
The size of the memory monitor's cache for ACLS.- See Also:
- Constant Field Values
-
N_SIZE_CONTAINERPAGE_OFFLINE
public static final java.lang.String N_SIZE_CONTAINERPAGE_OFFLINE
The size of the memory monitor's cache for offline container pages.- See Also:
- Constant Field Values
-
N_SIZE_CONTAINERPAGE_ONLINE
public static final java.lang.String N_SIZE_CONTAINERPAGE_ONLINE
The size of the memory monitor's cache for online container pages.- See Also:
- Constant Field Values
-
N_SIZE_GROUPS
public static final java.lang.String N_SIZE_GROUPS
The size of the memory monitor's cache for groups.- See Also:
- Constant Field Values
-
N_SIZE_ORGUNITS
public static final java.lang.String N_SIZE_ORGUNITS
The size of the memory monitor's cache for organizational units.- See Also:
- Constant Field Values
-
N_SIZE_PERMISSIONS
public static final java.lang.String N_SIZE_PERMISSIONS
The size of the memory monitor's cache for permission checks.- See Also:
- Constant Field Values
-
N_SIZE_PROJECTRESOURCES
public static final java.lang.String N_SIZE_PROJECTRESOURCES
The size of the memory monitor's cache for project resources.- See Also:
- Constant Field Values
-
N_SIZE_PROJECTS
public static final java.lang.String N_SIZE_PROJECTS
The size of the memory monitor's cache for projects.- See Also:
- Constant Field Values
-
N_SIZE_PROPERTIES
public static final java.lang.String N_SIZE_PROPERTIES
The size of the memory monitor's cache for properties.- See Also:
- Constant Field Values
-
N_SIZE_PROPERTYLISTS
public static final java.lang.String N_SIZE_PROPERTYLISTS
The size of the memory monitor's cache for property lists.- See Also:
- Constant Field Values
-
N_SIZE_RESOURCELISTS
public static final java.lang.String N_SIZE_RESOURCELISTS
The size of the memory monitor's cache for lists of resources.- See Also:
- Constant Field Values
-
N_SIZE_RESOURCES
public static final java.lang.String N_SIZE_RESOURCES
The size of the memory monitor's cache for resources.- See Also:
- Constant Field Values
-
N_SIZE_ROLES
public static final java.lang.String N_SIZE_ROLES
The size of the memory monitor's cache for roles.- See Also:
- Constant Field Values
-
N_SIZE_USERGROUPS
public static final java.lang.String N_SIZE_USERGROUPS
The size of the memory monitor's cache for user/group relations.- See Also:
- Constant Field Values
-
N_SIZE_USERS
public static final java.lang.String N_SIZE_USERS
The size of the memory monitor's cache for users.- See Also:
- Constant Field Values
-
N_SUBSCRIPTIONMANAGER
public static final java.lang.String N_SUBSCRIPTIONMANAGER
The subscriptionmanager node name.- See Also:
- Constant Field Values
-
N_SYSTEM
public static final java.lang.String N_SYSTEM
The main system configuration node name.- See Also:
- Constant Field Values
-
N_TEXT_ENCRYPTION
public static final java.lang.String N_TEXT_ENCRYPTION
Node name for declaring a single text encryption.- See Also:
- Constant Field Values
-
N_TIMEZONE
public static final java.lang.String N_TIMEZONE
The node name for the time zone configuration.- See Also:
- Constant Field Values
-
N_TOKEN_LIFETIME
public static final java.lang.String N_TOKEN_LIFETIME
Node name for the authorization token lifetime.- See Also:
- Constant Field Values
-
N_USER_ADMIN
public static final java.lang.String N_USER_ADMIN
The node name for the user-admin node.- See Also:
- Constant Field Values
-
N_USER_DATA_CHECK_INTERVAL
public static final java.lang.String N_USER_DATA_CHECK_INTERVAL
Node name for the user data check interval.- See Also:
- Constant Field Values
-
N_USER_DELETEDRESOURCE
public static final java.lang.String N_USER_DELETEDRESOURCE
The node name for the user-deletedresource node.- See Also:
- Constant Field Values
-
N_USER_EXPORT
public static final java.lang.String N_USER_EXPORT
The node name for the user-export node.- See Also:
- Constant Field Values
-
N_USER_GUEST
public static final java.lang.String N_USER_GUEST
The node name for the user-guest node.- See Also:
- Constant Field Values
-
N_VALIDATIONHANDLER
public static final java.lang.String N_VALIDATIONHANDLER
The node name for the validation handler.- See Also:
- Constant Field Values
-
N_VERSIONHISTORY
public static final java.lang.String N_VERSIONHISTORY
The node name for the version history.- See Also:
- Constant Field Values
-
N_WARNING_INTERVAL
public static final java.lang.String N_WARNING_INTERVAL
The node name for the warning-interval node.- See Also:
- Constant Field Values
-
N_WEBSERVERSCRIPTING
public static final java.lang.String N_WEBSERVERSCRIPTING
The node name which indicates if apache should be configurable in sitemanager.- See Also:
- Constant Field Values
-
N_WEBSERVERSCRIPTING_CONFIGTEMPLATE
public static final java.lang.String N_WEBSERVERSCRIPTING_CONFIGTEMPLATE
- See Also:
- Constant Field Values
-
N_WEBSERVERSCRIPTING_FILENAMEPREFIX
public static final java.lang.String N_WEBSERVERSCRIPTING_FILENAMEPREFIX
- See Also:
- Constant Field Values
-
N_WEBSERVERSCRIPTING_LOGGINGDIR
public static final java.lang.String N_WEBSERVERSCRIPTING_LOGGINGDIR
- See Also:
- Constant Field Values
-
N_WEBSERVERSCRIPTING_SECURETEMPLATE
public static final java.lang.String N_WEBSERVERSCRIPTING_SECURETEMPLATE
- See Also:
- Constant Field Values
-
N_WEBSERVERSCRIPTING_TARGETPATH
public static final java.lang.String N_WEBSERVERSCRIPTING_TARGETPATH
- See Also:
- Constant Field Values
-
N_WEBSERVERSCRIPTING_WEBSERVERSCRIPT
public static final java.lang.String N_WEBSERVERSCRIPTING_WEBSERVERSCRIPT
- See Also:
- Constant Field Values
-
N_WORKFLOW
public static final java.lang.String N_WORKFLOW
The node name for the workflow configuration.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsSystemConfiguration
public CmsSystemConfiguration()
-
-
Method Detail
-
addAdeParameter
public void addAdeParameter(java.lang.String name, java.lang.String value)
Adds an ADE configuration parameter.- Parameters:
name
- the parameter namevalue
- the parameter value
-
addAuthorizationHandlerParam
public void addAuthorizationHandlerParam(java.lang.String name, java.lang.String value)
Adds a parameter for the authorization handler.- Parameters:
name
- the parameter namevalue
- the parameter value
-
addConfigurationParameter
public void addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)
Description copied from interface:I_CmsConfigurationParameterHandler
Adds a configuration parameter to this parameter configurable class instance.- Specified by:
addConfigurationParameter
in interfaceI_CmsConfigurationParameterHandler
- Overrides:
addConfigurationParameter
in classA_CmsXmlConfiguration
- Parameters:
paramName
- the name of the parameterparamValue
- the value for the parameter- See Also:
I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)
-
addEventManager
public void addEventManager(java.lang.String clazz)
Adds the event manager class.- Parameters:
clazz
- the class name of event manager class to instantiate and add
-
addRequestHandler
public void addRequestHandler(java.lang.String clazz, CmsParameterConfiguration params)
Adds a new instance of a request handler class.- Parameters:
clazz
- the class name of the request handler to instantiate and add
-
addResourceInitHandler
public void addResourceInitHandler(java.lang.String clazz, CmsParameterConfiguration params) throws CmsConfigurationException
Adds a new instance of a resource init handler class.- Parameters:
clazz
- the class name of the resource init handler to instantiate and addparams
- the parameters set for the resource init handler (parameters need to be copied out, the object will be modified after use)- Throws:
CmsConfigurationException
-
addXmlDigesterRules
public void addXmlDigesterRules(org.apache.commons.digester3.Digester digester)
Description copied from interface:I_CmsXmlConfiguration
Digests an XML node and creates an instance of this configurable class.- Parameters:
digester
- the digester to use- See Also:
I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester3.Digester)
-
generateXml
public org.dom4j.Element generateXml(org.dom4j.Element parent)
Description copied from interface:I_CmsXmlConfiguration
Generates the XML element for this configurable class.- Parameters:
parent
- the parent element in the XML tree- Returns:
- the XML element for this configurable class
- See Also:
I_CmsXmlConfiguration.generateXml(org.dom4j.Element)
-
getAdeCacheSettings
public CmsADECacheSettings getAdeCacheSettings()
Returns the settings of the ADE cache.- Returns:
- the settings of the ADE cache
-
getAdeConfiguration
public java.lang.String getAdeConfiguration()
Returns the ade configuration class name.- Returns:
- the ade configuration class name
-
getAdeParameters
public java.util.Map<java.lang.String,java.lang.String> getAdeParameters()
Gets the ADE configuration parameters.- Returns:
- the ADE configuration parameters
-
getApiAuthorizations
public java.util.Map<java.lang.String,I_CmsApiAuthorizationHandler> getApiAuthorizations()
Gets the map of API authorization handlers (with names as keys).- Returns:
- the map of API authorization handlers
-
getAuthorizationHandler
public I_CmsAuthorizationHandler getAuthorizationHandler()
Returns an instance of the configured authorization handler.- Returns:
- an instance of the configured authorization handler
-
getCacheSettings
public CmsCacheSettings getCacheSettings()
Returns the settings of the memory monitor.- Returns:
- the settings of the memory monitor
-
getCmsDefaultUsers
public CmsDefaultUsers getCmsDefaultUsers()
Returns the default users.- Returns:
- the default users
-
getCmsFlexCacheConfiguration
public CmsFlexCacheConfiguration getCmsFlexCacheConfiguration()
Returns the flexCacheConfiguration.- Returns:
- the flexCacheConfiguration
-
getCmsMemoryMonitorConfiguration
public CmsMemoryMonitorConfiguration getCmsMemoryMonitorConfiguration()
Returns the memory monitor configuration.- Returns:
- the memory monitor configuration
-
getCredentialsResolver
public I_CmsCredentialsResolver getCredentialsResolver()
Gets the credentials resolver.- Returns:
- the credentials resolver
-
getCredentialsResolverClass
public java.lang.String getCredentialsResolverClass()
Gets the configured credentials resolver class name (null if no class is explicity configured).- Returns:
- the name of the configured credentials resolver class
-
getDefaultContentEncoding
public java.lang.String getDefaultContentEncoding()
Returns the defaultContentEncoding.- Returns:
- the defaultContentEncoding
-
getDetailPageHandler
public I_CmsDetailPageHandler getDetailPageHandler()
Gets the detail page handler.- Returns:
- the detail page handler
-
getDtdFilename
public java.lang.String getDtdFilename()
Description copied from interface:I_CmsXmlConfiguration
Returns the name of the DTD file for this XML configuration, e.g.opencms-configuration.dtd
.- Returns:
- the name of the DTD file for this XML configuration
- See Also:
I_CmsXmlConfiguration.getDtdFilename()
-
getEventManager
public CmsEventManager getEventManager()
Returns the configured OpenCms event manager instance.- Returns:
- the configured OpenCms event manager instance
-
getHistoryVersions
public int getHistoryVersions()
Returns the maximum number of versions that are kept per resource in the VFS version history.If the version history is disabled, this setting has no effect.
- Returns:
- the maximum number of versions that are kept per resource
- See Also:
isHistoryEnabled()
-
getHistoryVersionsAfterDeletion
public int getHistoryVersionsAfterDeletion()
Returns the maximum number of versions that are kept in the VFS version history for deleted resources.If the version history is disabled, this setting has no effect.
- Returns:
- the maximum number of versions that are kept for deleted resources
- See Also:
isHistoryEnabled()
-
getHttpAuthenticationSettings
public CmsHttpAuthenticationSettings getHttpAuthenticationSettings()
Returns the HTTP authentication settings.- Returns:
- the HTTP authentication settings
-
getLetsEncryptConfig
public CmsLetsEncryptConfiguration getLetsEncryptConfig()
Gets the LetsEncrypt configuration.- Returns:
- the LetsEncrypt configuration
-
getLocaleManager
public CmsLocaleManager getLocaleManager()
Returns the configured locale manager for multi language support.- Returns:
- the configured locale manager for multi language support
-
getLoginManager
public CmsLoginManager getLoginManager()
Returns the configured login manager.- Returns:
- the configured login manager
-
getMailSettings
public CmsMailSettings getMailSettings()
Returns the configured mail settings.- Returns:
- the configured mail settings
-
getNotificationProject
public java.lang.String getNotificationProject()
Returns the project in which timestamps for the content notification are read.- Returns:
- the project in which timestamps for the content notification are read
-
getNotificationTime
public int getNotificationTime()
Returns the duration after which responsibles will be notified about out-dated content (in days).- Returns:
- the duration after which responsibles will be notified about out-dated content
-
getPasswordHandler
public I_CmsPasswordHandler getPasswordHandler()
Returns the configured password handler.- Returns:
- the configured password handler
-
getPermissionHandler
public java.lang.String getPermissionHandler()
Returns the permission Handler class name.- Returns:
- the permission Handler class name
-
getPublishListRemoveMode
public CmsPublishManager.PublishListRemoveMode getPublishListRemoveMode()
Returns the configured publish list remove mode, or a default value if there is no configured value or an erroneous configured value.- Returns:
- the publish list remove mode
-
getPublishListRemoveModeStr
public java.lang.String getPublishListRemoveModeStr()
Returns the configured publish list remove mode as a string, or null if no publish list remove mode has been configured.- Returns:
- the publish list remove mode string from the configuration
-
getPublishManager
public CmsPublishManager getPublishManager()
Returns the configured publish manager.- Returns:
- the configured publish manager
-
getRequestHandlers
public java.util.List<I_CmsRequestHandler> getRequestHandlers()
Returns the list of instantiated request handler classes.- Returns:
- the list of instantiated request handler classes
-
getResourceInitHandlers
public java.util.List<I_CmsResourceInit> getResourceInitHandlers()
Returns the list of instantiated resource init handler classes.- Returns:
- the list of instantiated resource init handler classes
-
getRuntimeInfoFactory
public I_CmsDbContextFactory getRuntimeInfoFactory()
Returns the runtime info factory instance.- Returns:
- the runtime info factory instance
-
getRuntimeProperties
public java.util.Map<java.lang.String,java.lang.String> getRuntimeProperties()
Returns the runtime Properties.- Returns:
- the runtime Properties
-
getSessionStorageProvider
public I_CmsSessionStorageProvider getSessionStorageProvider()
Returns an instance of the configured session storage provider.- Returns:
- an instance of the configured session storage provider
-
getShellServerOptions
public CmsRemoteShellConfiguration getShellServerOptions()
Returns the shell server options.- Returns:
- the shell server options
-
getSubscriptionManager
public CmsSubscriptionManager getSubscriptionManager()
Returns the configured subscription manager.- Returns:
- the configured subscription manager
-
getTempFileProjectId
public int getTempFileProjectId()
Returns temporary file project id.- Returns:
- temporary file project id
-
getTextEncryptions
public java.util.Map<java.lang.String,I_CmsTextEncryption> getTextEncryptions()
Gets the map of text encryptions.- Returns:
- the map of text encryptions
-
getTwoFactorAuthenticationConfig
public CmsTwoFactorAuthenticationConfig getTwoFactorAuthenticationConfig()
Gets the two-factor authentication configuration.- Returns:
- the two-factor auth configuration
-
getUserDataRequestManager
public CmsUserDataRequestManager getUserDataRequestManager()
Gets the user data request manager.- Returns:
- the user data request manager
-
getUserSessionMode
public CmsSystemConfiguration.UserSessionMode getUserSessionMode(boolean useDefault)
Gets the user session mode.- Parameters:
useDefault
- if true, and no user session mode was configured, this will return the default value- Returns:
- the user session mode
-
getValidationHandler
public I_CmsValidationHandler getValidationHandler()
Returns an instance of the configured validation handler.- Returns:
- an instance of the configured validation handler
-
getWorkflowManager
public I_CmsWorkflowManager getWorkflowManager()
Gets the configured workflow manager instance.- Returns:
- the configured workflow manager instance.
-
initializeFinished
public void initializeFinished()
Will be called when configuration of this object is finished.
-
isHistoryEnabled
public boolean isHistoryEnabled()
Returns if the VFS version history is enabled.- Returns:
- if the VFS version history is enabled
-
isRestrictDetailContents
public boolean isRestrictDetailContents()
Returns true if detail contents are restricted to detail pages from the same site.- Returns:
- true if detail contents are restricted to detail pages from the same site
-
setAdeCacheSettings
public void setAdeCacheSettings(CmsADECacheSettings settings)
Sets the cache settings for ADE.- Parameters:
settings
- the cache settings for ADE
-
setAdeConfiguration
public void setAdeConfiguration(java.lang.String className)
Sets the ADE configuration class name.- Parameters:
className
- the class name to set
-
setAuthorizationHandler
public void setAuthorizationHandler(java.lang.String authorizationHandlerClass)
Sets the authorization handler.- Parameters:
authorizationHandlerClass
- the authorization handler class to set.
-
setCacheSettings
public void setCacheSettings(CmsCacheSettings settings)
Sets the settings of the memory monitor.- Parameters:
settings
- the settings of the memory monitor
-
setCmsDefaultUsers
public void setCmsDefaultUsers(java.lang.String userAdmin, java.lang.String userGuest, java.lang.String userExport, java.lang.String userDeletedResource, java.lang.String groupAdministrators, java.lang.String groupUsers, java.lang.String groupGuests)
Sets the CmsDefaultUsers.- Parameters:
userAdmin
- the name of the default admin useruserGuest
- the name of the guest useruserExport
- the name of the export useruserDeletedResource
- the name of the deleted resource user, can benull
groupAdministrators
- the name of the administrators groupgroupUsers
- the name of the users groupgroupGuests
- the name of the guests group
-
setCmsFlexCacheConfiguration
public void setCmsFlexCacheConfiguration(CmsFlexCacheConfiguration flexCacheConfiguration)
Sets the flexCacheConfiguration.- Parameters:
flexCacheConfiguration
- the flexCacheConfiguration to set
-
setCmsMemoryMonitorConfiguration
public void setCmsMemoryMonitorConfiguration(CmsMemoryMonitorConfiguration cmsMemoryMonitorConfiguration)
Sets the cmsMemoryMonitorConfiguration.- Parameters:
cmsMemoryMonitorConfiguration
- the cmsMemoryMonitorConfiguration to set
-
setCredentialsResolver
public void setCredentialsResolver(java.lang.String className) throws java.lang.Exception
Sets the credentials resolver class.- Parameters:
className
- the name of the credentials resolver class- Throws:
java.lang.Exception
- if something goes wrong
-
setDefaultContentEncoding
public void setDefaultContentEncoding(java.lang.String defaultContentEncoding)
Sets the defaultContentEncoding.- Parameters:
defaultContentEncoding
- the defaultContentEncoding to set
-
setDetailPageHandler
public void setDetailPageHandler(I_CmsDetailPageHandler handler)
Sets the detail page handler.- Parameters:
handler
- the detail page handler
-
setHistorySettings
public void setHistorySettings(java.lang.String historyEnabled, java.lang.String historyVersions, java.lang.String historyVersionsAfterDeletion)
VFS version history settings are set here.- Parameters:
historyEnabled
- if true the history is enabledhistoryVersions
- the maximum number of versions that are kept per VFS resourcehistoryVersionsAfterDeletion
- the maximum number of versions for deleted resources
-
setHttpAuthenticationSettings
public void setHttpAuthenticationSettings(CmsHttpAuthenticationSettings httpAuthenticationSettings)
Sets the HTTP authentication settings.- Parameters:
httpAuthenticationSettings
- the HTTP authentication settings to set
-
setLetsEncryptConfig
public void setLetsEncryptConfig(CmsLetsEncryptConfiguration letsEncryptConfig)
Sets the LetsEncrypt configuration.- Parameters:
letsEncryptConfig
- the LetsEncrypt configuration
-
setLocaleManager
public void setLocaleManager(CmsLocaleManager localeManager)
Sets the locale manager for multi language support.- Parameters:
localeManager
- the locale manager to set
-
setLoginManager
public void setLoginManager(java.lang.String disableMinutesStr, java.lang.String maxBadAttemptsStr, java.lang.String enableSecurityStr, java.lang.String tokenLifetime, java.lang.String maxInactive, java.lang.String passwordChangeInterval, java.lang.String userDataCheckInterval, java.lang.String requireOrgUnitStr, java.lang.String logoutUri)
Sets the configured login manager.- Parameters:
maxBadAttemptsStr
- the number of allowed bad login attemptsdisableMinutesStr
- the time an account gets locked if to many bad logins are attemptedenableSecurityStr
- flag to determine if the security option should be enabled on the login dialogtokenLifetime
- the token lifetimemaxInactive
- maximum time since last login before CmsLockInactiveAccountsJob locks an accountpasswordChangeInterval
- the password change intervaluserDataCheckInterval
- the user data check intervallogoutUri
- the alternative logout handler URI (may be null)
-
setMailSettings
public void setMailSettings(CmsMailSettings mailSettings)
Sets the mail settings.- Parameters:
mailSettings
- the mail settings to set.
-
setNotificationProject
public void setNotificationProject(java.lang.String notificationProject)
Sets the project in which timestamps for the content notification are read.- Parameters:
notificationProject
- the project in which timestamps for the content notification are read
-
setNotificationTime
public void setNotificationTime(java.lang.String notificationTime)
Sets the duration after which responsibles will be notified about out-dated content (in days).- Parameters:
notificationTime
- the duration after which responsibles will be notified about out-dated content
-
setPasswordHandler
public void setPasswordHandler(I_CmsPasswordHandler passwordHandler)
Sets the password handler class.- Parameters:
passwordHandler
- the password handler to set
-
setPermissionHandler
public void setPermissionHandler(java.lang.String permissionHandler)
Sets the permission Handler class name.- Parameters:
permissionHandler
- the class name to set
-
setPreventResponseFlush
public void setPreventResponseFlush(java.lang.String configValue)
Sets the servlet container specific setting.- Parameters:
configValue
- the configuration value
-
setPublishListRemoveMode
public void setPublishListRemoveMode(java.lang.String removeMode)
Sets the publish list remove mode.- Parameters:
removeMode
- the publish list remove mode
-
setPublishManager
public void setPublishManager(CmsPublishManager publishManager)
Sets the publish manager.- Parameters:
publishManager
- the publish manager
-
setReleaseTagsAfterEnd
public void setReleaseTagsAfterEnd(java.lang.String configValue)
Sets the servlet container specific setting.- Parameters:
configValue
- the configuration value
-
setRequestErrorPageAttribute
public void setRequestErrorPageAttribute(java.lang.String configValue)
Sets the servlet container specific setting.- Parameters:
configValue
- the configuration value
-
setRestrictDetailContents
public void setRestrictDetailContents(java.lang.String restrictDetailContents)
Sets the 'restrict detail contents' option.- Parameters:
restrictDetailContents
- the value of the option
-
setRuntimeInfoFactory
public void setRuntimeInfoFactory(java.lang.String className)
Sets the runtime info factory.- Parameters:
className
- the class name of the configured runtime info factory
-
setServletContainerSettingsMode
public void setServletContainerSettingsMode(java.lang.String configValue)
Sets the servlet container settings configuration mode.- Parameters:
configValue
- the value to set
-
setSessionStorageProvider
public void setSessionStorageProvider(java.lang.String sessionStorageProviderClass)
Sets the session storage provider.- Parameters:
sessionStorageProviderClass
- the session storage provider class to set.
-
setShellServerOptions
public void setShellServerOptions(java.lang.String enabled, java.lang.String portStr)
Sets the shell server options from the confriguration.- Parameters:
enabled
- the value of the 'enabled' attributeportStr
- the value of the 'port' attribute
-
setSubscriptionManager
public void setSubscriptionManager(CmsSubscriptionManager subscriptionManager)
Sets the subscription manager.- Parameters:
subscriptionManager
- the subscription manager
-
setTempFileProjectId
public void setTempFileProjectId(java.lang.String tempFileProjectId)
Sets the temporary file project id.- Parameters:
tempFileProjectId
- the temporary file project id to set
-
setUserDataRequestManager
public void setUserDataRequestManager(CmsUserDataRequestManager manager)
Sets the user data request manager.- Parameters:
manager
- the user data request manager
-
setUserSessionMode
public void setUserSessionMode(java.lang.String userSessionMode)
Sets the user session mode.- Parameters:
userSessionMode
- the user session mode
-
setUseSaxImplSystemProperties
public void setUseSaxImplSystemProperties(java.lang.String enabled)
Sets if the SAX parser implementation classes should be stored in system properties to improve the unmarshalling performance.- Parameters:
enabled
-true
to store SAX parser implementation classes in system properties
-
setValidationHandler
public void setValidationHandler(java.lang.String validationHandlerClass)
Sets the validation handler.- Parameters:
validationHandlerClass
- the validation handler class to set.
-
setWorkflowManager
public void setWorkflowManager(I_CmsWorkflowManager workflowManager)
Sets the configured workflow manager instance.- Parameters:
workflowManager
- the configured workflow manager
-
useSaxImplSystemProperties
public boolean useSaxImplSystemProperties()
Returns whether the SAX parser implementation classes should be stored in system properties to improve the unmarshalling performance.- Returns:
true
if the SAX parser implementation classes should be stored in system properties
-
addApiAuthorization
protected void addApiAuthorization(CmsSystemConfiguration.ApiAuthorizationConfig config)
Adds a new authorization configuration.- Parameters:
config
- the authorization configuration to add
-
initMembers
protected void initMembers()
Description copied from class:A_CmsXmlConfiguration
Initializes member variables.- Specified by:
initMembers
in classA_CmsXmlConfiguration
- See Also:
A_CmsXmlConfiguration.initMembers()
-
-