Package org.opencms.configuration

Reads and writes the XML based OpenCms configuration files.

Since:

6.0.0

Interface Summary

Interface	Description
I_CmsConfigurationParameterHandler	Used for classes that are configurable using <param name="name">value</param> in the XML configuration.
I_CmsNeedsAdminCmsObject	Interface for configured classes that need a CmsObject with admin privileges.
I_CmsXmlConfiguration	Each configurable element in OpenCms must implement this interface.
I_CmsXmlConfigurationWithUpdateHandler	Interface for configurations which should run custom logic when the configuration is written back by OpenCms.

Class Summary

Class	Description
A_CmsXmlConfiguration	Abstract base implementation for xml configurations.
CmsAdditionalLogFolderConfig	Bean containing additional log folders available for the log file viewer.
CmsConfigurationCopyResource	Describes a resource to copy during the creation of a new resource.
CmsConfigurationManager	Configuration manager for digesting the OpenCms XML configuration.
CmsDefaultUserSettings	Default user workplace settings, used as default values for worklace settings in the user preferences.
CmsDefaultUserSettings.CmsPublishRelatedResourcesMode	Enumeration class for defining the publish related resources mode.
CmsDigesterResourceTypeCreationFactory	Factory to create resource type instances from the XML configuration.
CmsElementWithAttrsParamConfigHelper	Helper class for parsing an element with no content but several attributes into a subclass of I_CmsConfigurationParameterHandler.
CmsElementWithSubElementsParamConfigHelper	Helper class for parsing an element with several sub-elements which are text-valued (i.e.
CmsImportExportConfiguration	Import / export master configuration class.
CmsModuleConfiguration	Modules configuration class.
CmsParameterConfiguration	Provides convenient access to configuration parameters.
CmsParameterConfiguration.ParameterReader	Used to read parameter lines from a property file.
CmsParameterConfiguration.ParameterTokenizer	This class divides property value into tokens separated by ",".
CmsParameterStore	Class for accessing global 'weighted' configuration parameters defined in parameter files in the VFS.
CmsParameterStore.WeightedValue	An individual weighted parameter value, with a 'source' attribute for better debuggability.
CmsRemoteShellConfiguration	RMI shell server configuration.
CmsSchedulerConfiguration	Scheduled jobs configuration class.
CmsSearchConfiguration	Lucene search configuration class.
CmsSetNextRule	Rule implementation that invokes a method on the (top-1) (parent) object, passing as implicit first argument of type CmsObject and as a further argument the top stack instance.
CmsSitesConfiguration	Class to read and write the OpenCms site configuration.
CmsSystemConfiguration	System master configuration class.
CmsSystemConfiguration.ApiAuthorizationConfig	Data for creating API authorization handlers.
CmsVariablesConfiguration	Class to read and write the OpenCms site configuration.
CmsVfsConfiguration	VFS master configuration class.
CmsWorkplaceConfiguration	Import/Export master configuration class.
Messages	Convenience class to access the localized messages of this OpenCms package.

Enum Summary

Enum	Description
CmsDefaultUserSettings.SubsitemapCreationMode	Enum for the subsitemap creation mode.
CmsSystemConfiguration.UserSessionMode	Enum for the user session mode.

Exception Summary

Exception	Description
CmsConfigurationException	Exceptions that occur during the XML configuration process.