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
implements I_CmsXmlConfiguration

VFS master configuration class.

Since:

6.0.0

Version:

$Revision: 1.37 $

Author:

Alexander Kandzior

Field Summary

static String	A_ERROR The "error" attribute.
static String	A_EXCLUSIVE The "exclusive" attribute.
static String	A_SERVER The "server" attribute.
static String	CONFIGURATION_DTD_NAME The name of the DTD for this configuration.
static String	DEFAULT_XML_FILE_NAME The name of the default XML file for this configuration.
static String	N_ACTIVE The node name for the job "active" value.
static String	N_ALIAS The node name for the alias node.
static String	N_AVGCACHEBYTES The node name for the avgcachebytes node.
static String	N_BROWSER_BASED The node name for the browser-based node.
static String	N_CACHE the result cache node.
static String	N_CACHE_ENABLED The node name for the cache-enabled node.
static String	N_CACHE_OFFLINE The node name for the cache-offline node.
static String	N_CLASS The node name for a job class.
static String	N_CONTENT_NOTIFICATION The duration after which responsibles will be notified about out-dated content.
static String	N_CONTEXT The node name for the job context.
static String	N_CRONEXPRESSION The node name for the job cron expression.
static String	N_DEFAULT_CONTENT_ENCODING The node name for the defaultcontentencoding node.
static String	N_DEFAULT_URI The node name for the default-uri node.
static String	N_DEFAULTUSERS The node name for the defaultusers expression.
static String	N_DIGESTTYPE The node name for the digest type.
static String	N_DISABLEMINUTES The node name for the login account lock minutes.
static String	N_EMAIL_INTERVAL The node name for the email-interval node.
static String	N_EMAIL_RECEIVER The node name for the email-receiver node.
static String	N_EMAIL_SENDER The node name for the email-sender node.
static String	N_ENABLED The node name for the login message enabled flag.
static String	N_ENCODING The node name for the context encoding.
static String	N_EVENTMANAGER The node name for the request handler classes.
static String	N_EVENTS The node name for the events node.
static String	N_FLEXCACHE The node name for the flexcache node.
static String	N_FORM_BASED The node name for the form-based node.
static String	N_GROUP_ADMINISTRATORS The node name for the group-administrators node.
static String	N_GROUP_GUESTS The node name for the group-guests node.
static String	N_GROUP_PROJECTMANAGERS The node name for the group-projectmanagers node.
static String	N_GROUP_USERS The node name for the group-users node.
static String	N_HTTP_AUTHENTICATION The node name for the http-authentication node.
static String	N_I18N The node name for the internationalization node.
static String	N_JOB The node name for a job.
static String	N_KEYGENERATOR The name of the class to generate cache keys.
static String	N_LOCALE The node name for individual locales.
static String	N_LOCALEHANDLER The node name for the locale handler.
static String	N_LOCALESCONFIGURED The node name for the configured locales.
static String	N_LOCALESDEFAULT The node name for the default locale(s).
static String	N_LOG_INTERVAL The node name for the log-interval node.
static String	N_LOGINFORBIDDEN The node name for the login message login forbidden flag.
static String	N_LOGINMANAGER The node name for the login manager.
static String	N_LOGINMESSAGE The node name for the login message.
static String	N_MAIL The node name for the mail configuration.
static String	N_MAILFROM The node name for the "mail from" node.
static String	N_MAILHOST The node name for the "mail host" node.
static String	N_MAXBADATTEMPTS The node name for the login manager bad attempt count.
static String	N_MAXCACHEBYTES The node name for the maxcachebytes node.
static String	N_MAXENTRYBYTES The node name for the maxentrybytes node.
static String	N_MAXKEYS The node name for the maxkeys node.
static String	N_MAXUSAGE_PERCENT The node name for the maxusagepercent node.
static String	N_MEMORYMONITOR The node name for the memorymonitor node.
static String	N_MESSAGE The node name for the login message text.
static String	N_NOTIFICATION_PROJECT The duration after which responsibles will be notified about out-dated content.
static String	N_NOTIFICATION_TIME The duration after which responsibles will be notified about out-dated content.
static String	N_PARAMETERS The node name for the job parameters.
static String	N_PASSWORDENCODING The node name for the password encoding.
static String	N_PASSWORDHANDLER The node name for the password handler.
static String	N_PROJECT The node name for the context project name.
static String	N_RECEIVER The node name for the memory email receiver.
static String	N_REMOTEADDR The node name for the context remote addr.
static String	N_REQUESTEDURI The node name for the context requested uri.
static String	N_REQUESTHANDLER The node name for the request handler classes.
static String	N_REQUESTHANDLERS The node name for the request handlers.
static String	N_RESOURCEINIT The node name for the resource init classes.
static String	N_RESOURCEINITHANDLER The node name for the resource init classes.
static String	N_REUSEINSTANCE The node name for the job "reuseinstance" value.
static String	N_RUNTIMECLASSES The node name for the runtime info.
static String	N_RUNTIMEINFO The node name for the runtime info factory.
static String	N_RUNTIMEPROPERTIES The node name for the runtime properties node.
static String	N_SCHEDULER The node name for the scheduler.
static String	N_SECURE The node name for the secure site.
static String	N_SITEROOT The node name for the context site root.
static String	N_SITES The node name for the sites node.
static String	N_SIZE_ACLS The size of the driver manager's cache for ACLS.
static String	N_SIZE_GROUPS The size of the driver manager's cache for groups.
static String	N_SIZE_PERMISSIONS The size of the security manager's cache for permission checks.
static String	N_SIZE_PROJECTS The size of the driver manager's cache for projects.
static String	N_SIZE_PROPERTIES The size of the driver manager's cache for properties.
static String	N_SIZE_RESOURCELISTS The size of the driver manager's cache for lists of resources.
static String	N_SIZE_RESOURCES The size of the driver manager's cache for resources.
static String	N_SIZE_USERGROUPS The size of the driver manager's cache for user/group relations.
static String	N_SIZE_USERS The size of the driver manager's cache for users.
static String	N_SYSTEM The main system configuration node name.
static String	N_TIMEEND The node name for the login message end time.
static String	N_TIMESTART The node name for the login message start time.
static String	N_USER_ADMIN The node name for the user-admin node.
static String	N_USER_DELETEDRESOURCE The node name for the user-deletedresource node.
static String	N_USER_EXPORT The node name for the user-export node.
static String	N_USER_GUEST The node name for the user-guest node.
static String	N_USERNAME The node name for the context user name.
static String	N_VERSIONHISTORY The node name for the version history.
static String	N_WARNING_INTERVAL The node name for the warning-interval node.
static 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_DESTINATION, A_ENABLED, A_FROM, A_HANDLER, A_ICON, A_ID, A_KEY, A_NAME, A_ORDER, A_PASSWORD, 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()
Public constructor, will be called by configuration manager.

Method Summary

void	addConfigurationParameter(String paramName, String paramValue) Adds a configuration parameter to this parameter configurable class instance.
void	addEventManager(String clazz) Adds the event manager class.
void	addJobFromConfiguration(CmsScheduledJobInfo jobInfo) Adds a new job description for the scheduler.
void	addRequestHandler(String clazz) Adds a new instance of a request handler class.
void	addResourceInitHandler(String clazz) Adds a new instance of a resource init handler class.
void	addScheduleManager() Generates the schedule manager.
void	addXmlDigesterRules(Digester digester) Digests an XML node and creates an instance of this configurable class.
Element	generateXml(Element parent) Generates the XML element for this configurable class.
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.
String	getDefaultContentEncoding() Returns the defaultContentEncoding.
String	getDtdFilename() Returns the name of the DTD file for this XML configuration, e.g.
CmsEventManager	getEventManager() Returns the configured OpenCms event manager instance.
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.
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.
List	getRequestHandlers() Returns the list of instanciated request handler classes.
List	getResourceInitHandlers() Returns the list of instanciated resource init handler classes.
I_CmsDbContextFactory	getRuntimeInfoFactory() Returns the runtime info factory instance.
Map	getRuntimeProperties() Returns the runtime Properties.
CmsScheduleManager	getScheduleManager() Returns the configured schedule manager.
CmsSiteManager	getSiteManager() Returns the site manager.
int	getTempFileProjectId() Returns temporary file project id.
int	getVersionHistoryMaxCount() Returns the maximum number of versions that are kept per file in the VFS version history.
void	initializeFinished() Will be called when configuration of this object is finished.
boolean	isVersionHistoryEnabled() Returns if the VFS version history is enabled.
void	setCacheSettings(CmsCacheSettings settings) Sets the settings of the driver manager.
void	setCmsDefaultUsers(String userAdmin, String userGuest, String userExport, String userDeletedResource, String groupAdministrators, String groupProjectmanagers, String groupUsers, String groupGuests) Sets the CmsDefaultUsers.
void	setCmsFlexCacheConfiguration(CmsFlexCacheConfiguration flexCacheConfiguration) Sets the flexCacheConfiguration.
void	setCmsMemoryMonitorConfiguration(CmsMemoryMonitorConfiguration cmsMemoryMonitorConfiguration) Sets the cmsMemoryMonitorConfiguration.
void	setDefaultContentEncoding(String defaultContentEncoding) Sets the defaultContentEncoding.
void	setHttpAuthenticationSettings(CmsHttpAuthenticationSettings httpAuthenticationSettings) Sets the HTTP authentication settings.
void	setLocaleManager(CmsLocaleManager localeManager) Sets the locale manager for multi language support.
void	setLoginManager(String disableMinutesStr, 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(String notificationProject) Sets the project in which timestamps for the content notification are read.
void	setNotificationTime(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	setRuntimeInfoFactory(String className) Sets the runtime info factory.
void	setSiteManager(CmsSiteManager siteManager) Sets the site manager.
void	setTempFileProjectId(String tempFileProjectId) Sets the temporary file project id.
void	setVersionHistorySettings(String historyEnabled, String historyMaxCount) VFS version history settings are set here.

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

Methods inherited from interface org.opencms.configuration.I_CmsXmlConfiguration

getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

getConfiguration, initConfiguration

Field Detail

A_ERROR

public static final String A_ERROR

The "error" attribute.

See Also:

Constant Field Values

A_EXCLUSIVE

public static final String A_EXCLUSIVE

The "exclusive" attribute.

See Also:

Constant Field Values

A_SERVER

public static final String A_SERVER

The "server" attribute.

See Also:

Constant Field Values

CONFIGURATION_DTD_NAME

public static final String CONFIGURATION_DTD_NAME

The name of the DTD for this configuration.

See Also:

Constant Field Values

DEFAULT_XML_FILE_NAME

public static final 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 String N_ACTIVE

The node name for the job "active" value.

See Also:

Constant Field Values

N_ALIAS

public static final String N_ALIAS

The node name for the alias node.

See Also:

Constant Field Values

N_AVGCACHEBYTES

public static final String N_AVGCACHEBYTES

The node name for the avgcachebytes node.

See Also:

Constant Field Values

N_BROWSER_BASED

public static final String N_BROWSER_BASED

The node name for the browser-based node.

See Also:

Constant Field Values

N_CACHE

public static final String N_CACHE

the result cache node.

See Also:

Constant Field Values

N_CACHE_ENABLED

public static final String N_CACHE_ENABLED

The node name for the cache-enabled node.

See Also:

Constant Field Values

N_CACHE_OFFLINE

public static final String N_CACHE_OFFLINE

The node name for the cache-offline node.

See Also:

Constant Field Values

N_CLASS

public static final String N_CLASS

The node name for a job class.

See Also:

Constant Field Values

N_CONTENT_NOTIFICATION

public static final 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 String N_CONTEXT

The node name for the job context.

See Also:

Constant Field Values

N_CRONEXPRESSION

public static final String N_CRONEXPRESSION

The node name for the job cron expression.

See Also:

Constant Field Values

N_DEFAULT_CONTENT_ENCODING

public static final String N_DEFAULT_CONTENT_ENCODING

The node name for the defaultcontentencoding node.

See Also:

Constant Field Values

N_DEFAULT_URI

public static final String N_DEFAULT_URI

The node name for the default-uri node.

See Also:

Constant Field Values

N_DEFAULTUSERS

public static final String N_DEFAULTUSERS

The node name for the defaultusers expression.

See Also:

Constant Field Values

N_DIGESTTYPE

public static final String N_DIGESTTYPE

The node name for the digest type.

See Also:

Constant Field Values

N_DISABLEMINUTES

public static final String N_DISABLEMINUTES

The node name for the login account lock minutes.

See Also:

Constant Field Values

N_EMAIL_INTERVAL

public static final String N_EMAIL_INTERVAL

The node name for the email-interval node.

See Also:

Constant Field Values

N_EMAIL_RECEIVER

public static final String N_EMAIL_RECEIVER

The node name for the email-receiver node.

See Also:

Constant Field Values

N_EMAIL_SENDER

public static final String N_EMAIL_SENDER

The node name for the email-sender node.

See Also:

Constant Field Values

N_ENABLED

public static final String N_ENABLED

The node name for the login message enabled flag.

See Also:

Constant Field Values

N_ENCODING

public static final String N_ENCODING

The node name for the context encoding.

See Also:

Constant Field Values

N_EVENTMANAGER

public static final String N_EVENTMANAGER

The node name for the request handler classes.

See Also:

Constant Field Values

N_EVENTS

public static final String N_EVENTS

The node name for the events node.

See Also:

Constant Field Values

N_FLEXCACHE

public static final String N_FLEXCACHE

The node name for the flexcache node.

See Also:

Constant Field Values

N_FORM_BASED

public static final String N_FORM_BASED

The node name for the form-based node.

See Also:

Constant Field Values

N_GROUP_ADMINISTRATORS

public static final String N_GROUP_ADMINISTRATORS

The node name for the group-administrators node.

See Also:

Constant Field Values

N_GROUP_GUESTS

public static final String N_GROUP_GUESTS

The node name for the group-guests node.

See Also:

Constant Field Values

N_GROUP_PROJECTMANAGERS

public static final String N_GROUP_PROJECTMANAGERS

The node name for the group-projectmanagers node.

See Also:

Constant Field Values

N_GROUP_USERS

public static final String N_GROUP_USERS

The node name for the group-users node.

See Also:

Constant Field Values

N_HTTP_AUTHENTICATION

public static final String N_HTTP_AUTHENTICATION

The node name for the http-authentication node.

See Also:

Constant Field Values

N_I18N

public static final String N_I18N

The node name for the internationalization node.

See Also:

Constant Field Values

N_JOB

public static final String N_JOB

The node name for a job.

See Also:

Constant Field Values

N_KEYGENERATOR

public static final String N_KEYGENERATOR

The name of the class to generate cache keys.

See Also:

Constant Field Values

N_LOCALE

public static final String N_LOCALE

The node name for individual locales.

See Also:

Constant Field Values

N_LOCALEHANDLER

public static final String N_LOCALEHANDLER

The node name for the locale handler.

See Also:

Constant Field Values

N_LOCALESCONFIGURED

public static final String N_LOCALESCONFIGURED

The node name for the configured locales.

See Also:

Constant Field Values

N_LOCALESDEFAULT

public static final String N_LOCALESDEFAULT

The node name for the default locale(s).

See Also:

Constant Field Values

N_LOG_INTERVAL

public static final String N_LOG_INTERVAL

The node name for the log-interval node.

See Also:

Constant Field Values

N_LOGINFORBIDDEN

public static final String N_LOGINFORBIDDEN

The node name for the login message login forbidden flag.

See Also:

Constant Field Values

N_LOGINMANAGER

public static final String N_LOGINMANAGER

The node name for the login manager.

See Also:

Constant Field Values

N_LOGINMESSAGE

public static final String N_LOGINMESSAGE

The node name for the login message.

See Also:

Constant Field Values

N_MAIL

public static final String N_MAIL

The node name for the mail configuration.

See Also:

Constant Field Values

N_MAILFROM

public static final String N_MAILFROM

The node name for the "mail from" node.

See Also:

Constant Field Values

N_MAILHOST

public static final String N_MAILHOST

The node name for the "mail host" node.

See Also:

Constant Field Values

N_MAXBADATTEMPTS

public static final String N_MAXBADATTEMPTS

The node name for the login manager bad attempt count.

See Also:

Constant Field Values

N_MAXCACHEBYTES

public static final String N_MAXCACHEBYTES

The node name for the maxcachebytes node.

See Also:

Constant Field Values

N_MAXENTRYBYTES

public static final String N_MAXENTRYBYTES

The node name for the maxentrybytes node.

See Also:

Constant Field Values

N_MAXKEYS

public static final String N_MAXKEYS

The node name for the maxkeys node.

See Also:

Constant Field Values

N_MAXUSAGE_PERCENT

public static final String N_MAXUSAGE_PERCENT

The node name for the maxusagepercent node.

See Also:

Constant Field Values

N_MEMORYMONITOR

public static final String N_MEMORYMONITOR

The node name for the memorymonitor node.

See Also:

Constant Field Values

N_MESSAGE

public static final String N_MESSAGE

The node name for the login message text.

See Also:

Constant Field Values

N_NOTIFICATION_PROJECT

public static final 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 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 String N_PARAMETERS

The node name for the job parameters.

See Also:

Constant Field Values

N_PASSWORDENCODING

public static final String N_PASSWORDENCODING

The node name for the password encoding.

See Also:

Constant Field Values

N_PASSWORDHANDLER

public static final String N_PASSWORDHANDLER

The node name for the password handler.

See Also:

Constant Field Values

N_PROJECT

public static final String N_PROJECT

The node name for the context project name.

See Also:

Constant Field Values

N_RECEIVER

public static final String N_RECEIVER

The node name for the memory email receiver.

See Also:

Constant Field Values

N_REMOTEADDR

public static final String N_REMOTEADDR

The node name for the context remote addr.

See Also:

Constant Field Values

N_REQUESTEDURI

public static final String N_REQUESTEDURI

The node name for the context requested uri.

See Also:

Constant Field Values

N_REQUESTHANDLER

public static final String N_REQUESTHANDLER

The node name for the request handler classes.

See Also:

Constant Field Values

N_REQUESTHANDLERS

public static final String N_REQUESTHANDLERS

The node name for the request handlers.

See Also:

Constant Field Values

N_RESOURCEINIT

public static final String N_RESOURCEINIT

The node name for the resource init classes.

See Also:

Constant Field Values

N_RESOURCEINITHANDLER

public static final String N_RESOURCEINITHANDLER

The node name for the resource init classes.

See Also:

Constant Field Values

N_REUSEINSTANCE

public static final String N_REUSEINSTANCE

The node name for the job "reuseinstance" value.

See Also:

Constant Field Values

N_RUNTIMECLASSES

public static final String N_RUNTIMECLASSES

The node name for the runtime info.

See Also:

Constant Field Values

N_RUNTIMEINFO

public static final String N_RUNTIMEINFO

The node name for the runtime info factory.

See Also:

Constant Field Values

N_RUNTIMEPROPERTIES

public static final String N_RUNTIMEPROPERTIES

The node name for the runtime properties node.

See Also:

Constant Field Values

N_SCHEDULER

public static final String N_SCHEDULER

The node name for the scheduler.

See Also:

Constant Field Values

N_SECURE

public static final String N_SECURE

The node name for the secure site.

See Also:

Constant Field Values

N_SITEROOT

public static final String N_SITEROOT

The node name for the context site root.

See Also:

Constant Field Values

N_SITES

public static final String N_SITES

The node name for the sites node.

See Also:

Constant Field Values

N_SIZE_ACLS

public static final 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 String N_SIZE_GROUPS

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

See Also:

Constant Field Values

N_SIZE_PERMISSIONS

public static final String N_SIZE_PERMISSIONS

The size of the security manager's cache for permission checks.

See Also:

Constant Field Values

N_SIZE_PROJECTS

public static final 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 String N_SIZE_PROPERTIES

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

See Also:

Constant Field Values

N_SIZE_RESOURCELISTS

public static final 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 String N_SIZE_RESOURCES

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

See Also:

Constant Field Values

N_SIZE_USERGROUPS

public static final 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 String N_SIZE_USERS

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

See Also:

Constant Field Values

N_SYSTEM

public static final String N_SYSTEM

The main system configuration node name.

See Also:

Constant Field Values

N_TIMEEND

public static final String N_TIMEEND

The node name for the login message end time.

See Also:

Constant Field Values

N_TIMESTART

public static final String N_TIMESTART

The node name for the login message start time.

See Also:

Constant Field Values

N_USER_ADMIN

public static final String N_USER_ADMIN

The node name for the user-admin node.

See Also:

Constant Field Values

N_USER_DELETEDRESOURCE

public static final String N_USER_DELETEDRESOURCE

The node name for the user-deletedresource node.

See Also:

Constant Field Values

N_USER_EXPORT

public static final String N_USER_EXPORT

The node name for the user-export node.

See Also:

Constant Field Values

N_USER_GUEST

public static final String N_USER_GUEST

The node name for the user-guest node.

See Also:

Constant Field Values

N_USERNAME

public static final String N_USERNAME

The node name for the context user name.

See Also:

Constant Field Values

N_VERSIONHISTORY

public static final String N_VERSIONHISTORY

The node name for the version history.

See Also:

Constant Field Values

N_WARNING_INTERVAL

public static final String N_WARNING_INTERVAL

The node name for the warning-interval node.

See Also:

Constant Field Values

N_WORKPLACE_SERVER

public static final String N_WORKPLACE_SERVER

The node name for the workplace-server node.

See Also:

Constant Field Values

Constructor Detail

CmsSystemConfiguration

public CmsSystemConfiguration()

Public constructor, will be called by configuration manager.

Method Detail

addConfigurationParameter

public void addConfigurationParameter(String paramName,
                                      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(String clazz)

Adds the event manager class.

Parameters:

clazz - the class name of event manager class to instanciate 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(String clazz)

Adds a new instance of a request handler class.

Parameters:

clazz - the class name of the request handler to instanciate and add

addResourceInitHandler

public void addResourceInitHandler(String clazz)

Adds a new instance of a resource init handler class.

Parameters:

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

addScheduleManager

public void addScheduleManager()

Generates the schedule manager.

addXmlDigesterRules

public void addXmlDigesterRules(Digester digester)

Description copied from interface: I_CmsXmlConfiguration

Digests an XML node and creates an instance of this configurable class.

Specified by:

addXmlDigesterRules in interface I_CmsXmlConfiguration

Parameters:

digester - the digester to use

See Also:

I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester.Digester)

generateXml

public Element generateXml(Element parent)

Description copied from interface: I_CmsXmlConfiguration

Generates the XML element for this configurable class.

Specified by:

generateXml in interface I_CmsXmlConfiguration

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)

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 String getDefaultContentEncoding()

Returns the defaultContentEncoding.

Returns:

the defaultContentEncoding

getDtdFilename

public String getDtdFilename()

Description copied from interface: I_CmsXmlConfiguration

Returns the name of the DTD file for this XML configuration, e.g. opencms-configuration.dtd.

Specified by:

getDtdFilename in interface I_CmsXmlConfiguration

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

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

getRequestHandlers

public List getRequestHandlers()

Returns the list of instanciated request handler classes.

Returns:

the list of instanciated request handler classes

getResourceInitHandlers

public List getResourceInitHandlers()

Returns the list of instanciated resource init handler classes.

Returns:

the list of instanciated resource init handler classes

getRuntimeInfoFactory

public I_CmsDbContextFactory getRuntimeInfoFactory()

Returns the runtime info factory instance.

Returns:

the runtime info factory instance

getRuntimeProperties

public Map getRuntimeProperties()

Returns the runtime Properties.

Returns:

the runtime Properties

getScheduleManager

public CmsScheduleManager getScheduleManager()

Returns the configured schedule manager.

Returns:

the configured schedule manager

getSiteManager

public CmsSiteManager getSiteManager()

Returns the site manager.

Returns:

the site manager

getTempFileProjectId

public int getTempFileProjectId()

Returns temporary file project id.

Returns:

temporary file project id

getVersionHistoryMaxCount

public int getVersionHistoryMaxCount()

Returns the maximum number of versions that are kept per file in the VFS version history.

If the versin history is disabled, this setting has no effect.

Returns:

the maximum number of versions that are kept per file

See Also:

isVersionHistoryEnabled()

initializeFinished

public void initializeFinished()

Will be called when configuration of this object is finished.

isVersionHistoryEnabled

public boolean isVersionHistoryEnabled()

Returns if the VFS version history is enabled.

Returns:

if the VFS version history is enabled

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(String userAdmin,
                               String userGuest,
                               String userExport,
                               String userDeletedResource,
                               String groupAdministrators,
                               String groupProjectmanagers,
                               String groupUsers,
                               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(String defaultContentEncoding)

Sets the defaultContentEncoding.

Parameters:

defaultContentEncoding - the defaultContentEncoding to set

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(String disableMinutesStr,
                            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(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(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

setRuntimeInfoFactory

public void setRuntimeInfoFactory(String className)

Sets the runtime info factory.

Parameters:

className - the class name of the configured runtime info factory

setSiteManager

public void setSiteManager(CmsSiteManager siteManager)

Sets the site manager.

Parameters:

siteManager - the site manager to set

setTempFileProjectId

public void setTempFileProjectId(String tempFileProjectId)

Sets the temporary file project id.

Parameters:

tempFileProjectId - the temporary file project id to set

setVersionHistorySettings

public void setVersionHistorySettings(String historyEnabled,
                                      String historyMaxCount)

VFS version history settings are set here.

Parameters:

historyEnabled - if true the history is enabled

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