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

Version:

$Revision: 1.56 $

Author:

Alexander Kandzior

Field Summary

static java.lang.String	A_ERROR The "error" attribute.
static java.lang.String	A_EXCLUSIVE The "exclusive" attribute.
static java.lang.String	A_MODE The "mode" attribute.
static java.lang.String	A_OFFSET The attribute name for the alias offset.
static java.lang.String	A_SERVER The "server" attribute.
static java.lang.String	CONFIGURATION_DTD_NAME The name of the DTD for this configuration.
static java.lang.String	DEFAULT_XML_FILE_NAME The name of the default XML file for this configuration.
static java.lang.String	N_ACTIVE The node name for the job "active" value.
static java.lang.String	N_ALIAS The node name for the alias node.
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 the result cache 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_CONTENT_NOTIFICATION The duration after which responsibles will be notified about out-dated content.
static java.lang.String	N_CONTEXT The node name for the job context.
static java.lang.String	N_CRONEXPRESSION The node name for the job cron expression.
static java.lang.String	N_DEFAULT_CONTENT_ENCODING The node name for the defaultcontentencoding node.
static java.lang.String	N_DEFAULT_URI The node name for the default-uri node.
static java.lang.String	N_DEFAULTUSERS The node name for the defaultusers expression.
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_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_ENABLED The node name for the login message enabled flag.
static java.lang.String	N_ENCODING The node name for the context encoding.
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_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_JOB The node name for a job.
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_LOGINFORBIDDEN The node name for the login message login forbidden flag.
static java.lang.String	N_LOGINMANAGER The node name for the login manager.
static java.lang.String	N_LOGINMESSAGE The node name for the login message.
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_MESSAGE The node name for the login message text.
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 job parameters.
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_PROJECT The node name for the context project name.
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_REMOTEADDR The node name for the context remote addr.
static java.lang.String	N_REQUESTEDURI The node name for the context requested uri.
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_REUSEINSTANCE The node name for the job "reuseinstance" value.
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_SCHEDULER The node name for the scheduler.
static java.lang.String	N_SECURE The node name for the secure site.
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_SITEROOT The node name for the context site root.
static java.lang.String	N_SITES The node name for the sites node.
static java.lang.String	N_SIZE_ACLS The size of the driver manager's cache for ACLS.
static java.lang.String	N_SIZE_GROUPS The size of the driver manager's cache for groups.
static java.lang.String	N_SIZE_ORGUNITS The size of the driver manager's cache for organizational units.
static java.lang.String	N_SIZE_PERMISSIONS The size of the security manager's cache for permission checks.
static java.lang.String	N_SIZE_PROJECTRESOURCES The size of the driver manager's cache for project resources.
static java.lang.String	N_SIZE_PROJECTS The size of the driver manager's cache for projects.
static java.lang.String	N_SIZE_PROPERTIES The size of the driver manager's cache for properties.
static java.lang.String	N_SIZE_PROPERTYLISTS The size of the driver manager's cache for property lists.
static java.lang.String	N_SIZE_RESOURCELISTS The size of the driver manager's cache for lists of resources.
static java.lang.String	N_SIZE_RESOURCES The size of the driver manager's cache for resources.
static java.lang.String	N_SIZE_ROLES The size of the driver manager's cache for roles.
static java.lang.String	N_SIZE_USERGROUPS The size of the driver manager's cache for user/group relations.
static java.lang.String	N_SIZE_USERS The size of the driver manager's cache for users.
static java.lang.String	N_SYSTEM The main system configuration node name.
static java.lang.String	N_TIMEEND The node name for the login message end time.
static java.lang.String	N_TIMESTART The node name for the login message start time.
static java.lang.String	N_USER_ADMIN The node name for the user-admin node.
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_USERNAME The node name for the context user name.
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_WORKPLACE_SERVER The node name for the workplace-server node.

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_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

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

CmsSystemConfiguration()

Method Summary

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	addJobFromConfiguration(CmsScheduledJobInfo jobInfo) Adds a new job description for the scheduler.
void	addRequestHandler(java.lang.String clazz) Adds a new instance of a request handler class.
void	addResourceInitHandler(java.lang.String clazz) Adds a new instance of a resource init handler class.
void	addScheduleManager() Generates the schedule manager.
void	addXmlDigesterRules(org.apache.commons.digester.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.
I_CmsAuthorizationHandler	getAuthorizationHandler() Returns an instance of the configured authorization handler.
CmsCacheSettings	getCacheSettings() Returns the settings of the driver manager.
CmsDefaultUsers	getCmsDefaultUsers() Returns the default users.
CmsFlexCacheConfiguration	getCmsFlexCacheConfiguration() Returns the flexCacheConfiguration.
CmsMemoryMonitorConfiguration	getCmsMemoryMonitorConfiguration() Returns the memory monitor configuration.
java.lang.String	getDefaultContentEncoding() Returns the defaultContentEncoding.
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.
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	getPublishManager() Returns the configured publish manager.
java.util.List	getRequestHandlers() Returns the list of instantiated request handler classes.
java.util.List	getResourceInitHandlers() Returns the list of instantiated resource init handler classes.
I_CmsDbContextFactory	getRuntimeInfoFactory() Returns the runtime info factory instance.
java.util.Map	getRuntimeProperties() Returns the runtime Properties.
CmsScheduleManager	getScheduleManager() Returns the configured schedule manager.
I_CmsSessionStorageProvider	getSessionStorageProvider() Returns an instance of the configured session storage provider.
CmsSiteManagerImpl	getSiteManager() Returns the site manager.
int	getTempFileProjectId() Returns temporary file project id.
I_CmsValidationHandler	getValidationHandler() Returns an instance of the configured validation handler.
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.
void	setAuthorizationHandler(java.lang.String authorizationHandlerClass) Sets the authorization handler.
void	setCacheSettings(CmsCacheSettings settings) Sets the settings of the driver manager.
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 groupProjectmanagers, 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	setDefaultContentEncoding(java.lang.String defaultContentEncoding) Sets the defaultContentEncoding.
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	setLocaleManager(CmsLocaleManager localeManager) Sets the locale manager for multi language support.
void	setLoginManager(java.lang.String disableMinutesStr, java.lang.String maxBadAttemptsStr) Sets the configured login manager.
void	setLoginMessage(CmsLoginMessage message) Adds the login message from the configuration.
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	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	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	setSiteManager(CmsSiteManagerImpl siteManager) Sets the site manager.
void	setTempFileProjectId(java.lang.String tempFileProjectId) Sets the temporary file project id.
void	setValidationHandler(java.lang.String validationHandlerClass) Sets the validation handler.

Methods inherited from class org.opencms.configuration.A_CmsXmlConfiguration

getConfiguration, getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName, initConfiguration, setXmlFileName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

A_ERROR

public static final java.lang.String A_ERROR

The "error" 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_MODE

public static final java.lang.String A_MODE

The "mode" attribute.

See Also:

Constant Field Values

A_OFFSET

public static final java.lang.String A_OFFSET

The attribute name for the alias offset.

See Also:

Constant Field Values

A_SERVER

public static final java.lang.String A_SERVER

The "server" 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_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_ACTIVE

public static final java.lang.String N_ACTIVE

The node name for the job "active" value.

See Also:

Constant Field Values

N_ALIAS

public static final java.lang.String N_ALIAS

The node name for the alias node.

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

public static final java.lang.String N_CACHE

the result cache 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_CONTENT_NOTIFICATION

public static final java.lang.String N_CONTENT_NOTIFICATION

The duration after which responsibles will be notified about out-dated content.

See Also:

Constant Field Values

N_CONTEXT

public static final java.lang.String N_CONTEXT

The node name for the job context.

See Also:

Constant Field Values

N_CRONEXPRESSION

public static final java.lang.String N_CRONEXPRESSION

The node name for the job cron expression.

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_DEFAULT_URI

public static final java.lang.String N_DEFAULT_URI

The node name for the default-uri 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_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_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_ENABLED

public static final java.lang.String N_ENABLED

The node name for the login message enabled flag.

See Also:

Constant Field Values

N_ENCODING

public static final java.lang.String N_ENCODING

The node name for the context encoding.

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_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_JOB

public static final java.lang.String N_JOB

The node name for a job.

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_LOGINFORBIDDEN

public static final java.lang.String N_LOGINFORBIDDEN

The node name for the login message login forbidden flag.

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_LOGINMESSAGE

public static final java.lang.String N_LOGINMESSAGE

The node name for the login message.

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_MESSAGE

public static final java.lang.String N_MESSAGE

The node name for the login message text.

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 job parameters.

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_PROJECT

public static final java.lang.String N_PROJECT

The node name for the context project name.

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_REMOTEADDR

public static final java.lang.String N_REMOTEADDR

The node name for the context remote addr.

See Also:

Constant Field Values

N_REQUESTEDURI

public static final java.lang.String N_REQUESTEDURI

The node name for the context requested uri.

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_REUSEINSTANCE

public static final java.lang.String N_REUSEINSTANCE

The node name for the job "reuseinstance" value.

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_SCHEDULER

public static final java.lang.String N_SCHEDULER

The node name for the scheduler.

See Also:

Constant Field Values

N_SECURE

public static final java.lang.String N_SECURE

The node name for the secure site.

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_SITEROOT

public static final java.lang.String N_SITEROOT

The node name for the context site root.

See Also:

Constant Field Values

N_SITES

public static final java.lang.String N_SITES

The node name for the sites node.

See Also:

Constant Field Values

N_SIZE_ACLS

public static final java.lang.String N_SIZE_ACLS

The size of the driver manager's cache for ACLS.

See Also:

Constant Field Values

N_SIZE_GROUPS

public static final java.lang.String N_SIZE_GROUPS

The size of the driver manager'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 driver manager'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 security manager'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 driver manager'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 driver manager'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 driver manager'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 driver manager'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 driver manager'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 driver manager'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 driver manager'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 driver manager'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 driver manager's cache for users.

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_TIMEEND

public static final java.lang.String N_TIMEEND

The node name for the login message end time.

See Also:

Constant Field Values

N_TIMESTART

public static final java.lang.String N_TIMESTART

The node name for the login message start time.

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_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_USERNAME

public static final java.lang.String N_USERNAME

The node name for the context user name.

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_WORKPLACE_SERVER

public static final java.lang.String N_WORKPLACE_SERVER

The node name for the workplace-server node.

See Also:

Constant Field Values

Constructor Detail

CmsSystemConfiguration

public CmsSystemConfiguration()

Method Detail

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 interface I_CmsConfigurationParameterHandler

Overrides:

addConfigurationParameter in class A_CmsXmlConfiguration

Parameters:

paramName - the name of the parameter

paramValue - 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

addJobFromConfiguration

public void addJobFromConfiguration(CmsScheduledJobInfo jobInfo)

Adds a new job description for the scheduler.

Parameters:

jobInfo - the job description to add

addRequestHandler

public void addRequestHandler(java.lang.String clazz)

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)

Adds a new instance of a resource init handler class.

Parameters:

clazz - the class name of the resource init handler to instantiate and add

addScheduleManager

public void addScheduleManager()

Generates the schedule manager.

addXmlDigesterRules

public void addXmlDigesterRules(org.apache.commons.digester.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.digester.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)

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 driver manager.

Returns:

the settings of the driver manager

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

getDefaultContentEncoding

public java.lang.String getDefaultContentEncoding()

Returns the defaultContentEncoding.

Returns:

the defaultContentEncoding

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

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

getPublishManager

public CmsPublishManager getPublishManager()

Returns the configured publish manager.

Returns:

the configured publish manager

getRequestHandlers

public java.util.List getRequestHandlers()

Returns the list of instantiated request handler classes.

Returns:

the list of instantiated request handler classes

getResourceInitHandlers

public java.util.List 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 getRuntimeProperties()

Returns the runtime Properties.

Returns:

the runtime Properties

getScheduleManager

public CmsScheduleManager getScheduleManager()

Returns the configured schedule manager.

Returns:

the configured schedule manager

getSessionStorageProvider

public I_CmsSessionStorageProvider getSessionStorageProvider()

Returns an instance of the configured session storage provider.

Returns:

an instance of the configured session storage provider

getSiteManager

public CmsSiteManagerImpl getSiteManager()

Returns the site manager.

Returns:

the site manager

getTempFileProjectId

public int getTempFileProjectId()

Returns temporary file project id.

Returns:

temporary file project id

getValidationHandler

public I_CmsValidationHandler getValidationHandler()

Returns an instance of the configured validation handler.

Returns:

an instance of the configured validation handler

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

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 driver manager.

Parameters:

settings - the settings of the driver manager

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 groupProjectmanagers,
                               java.lang.String groupUsers,
                               java.lang.String groupGuests)

Sets the CmsDefaultUsers.

Parameters:

userAdmin - the name of the default admin user

userGuest - the name of the guest user

userExport - the name of the export user

userDeletedResource - the name of the deleted resource user, can be null

groupAdministrators - the name of the administrators group

groupProjectmanagers - the name of the project managers group

groupUsers - the name of the users group

groupGuests - 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

setDefaultContentEncoding

public void setDefaultContentEncoding(java.lang.String defaultContentEncoding)

Sets the defaultContentEncoding.

Parameters:

defaultContentEncoding - the defaultContentEncoding to set

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 enabled

historyVersions - the maximum number of versions that are kept per VFS resource

historyVersionsAfterDeletion - 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

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)

Sets the configured login manager.

Parameters:

maxBadAttemptsStr - the number of allowed bad login attempts

disableMinutesStr - the time an account gets locked if to many bad logins are attempted

setLoginMessage

public void setLoginMessage(CmsLoginMessage message)

Adds the login message from the configuration.

Parameters:

message - the login message to add

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

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

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.

setSiteManager

public void setSiteManager(CmsSiteManagerImpl siteManager)

Sets the site manager.

Parameters:

siteManager - the site manager to set

setTempFileProjectId

public void setTempFileProjectId(java.lang.String tempFileProjectId)

Sets the temporary file project id.

Parameters:

tempFileProjectId - the temporary file project id to set

setValidationHandler

public void setValidationHandler(java.lang.String validationHandlerClass)

Sets the validation handler.

Parameters:

validationHandlerClass - the validation handler class to set.

initMembers

protected void initMembers()

Description copied from class: A_CmsXmlConfiguration

Initializes member variables.

Specified by:

initMembers in class A_CmsXmlConfiguration

See Also:

A_CmsXmlConfiguration.initMembers()