CmsConfigurationManager

java.lang.Object
- org.opencms.configuration.CmsConfigurationManager

所有已实现的接口:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration
```
public class CmsConfigurationManager
extends java.lang.Object
implements I_CmsXmlConfiguration
```
Configuration manager for digesting the OpenCms XML configuration.
Reads the individual configuration class nodes first and creaes new instances of the "base" configuration classes.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`DEFAULT_DTD_LOCATION` The location of the OpenCms configuration DTD if the default prefix is the system ID.
`static java.lang.String`	`DEFAULT_DTD_PREFIX` The default prefix for the OpenCms configuration DTD.
`static java.lang.String`	`DEFAULT_XML_FILE_NAME` The name of the default XML file for this configuration.
`static java.lang.String`	`DTD_FILE_NAME` The name of the DTD file for this configuration.
`protected static java.lang.String`	`N_CONFIG` The config node.
`protected static java.lang.String`	`N_CONFIGURATION` The configurations node.
`static java.lang.String`	`N_ROOT` The "opencms" root node of the XML configuration.
`static java.lang.String`	`POSTFIX_ORI` Postfix for original configuration files.

从接口继承的字段 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

从接口继承的字段 org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

构造器概要

构造器
构造器和说明

CmsConfigurationManager(java.lang.String baseFolder)
Creates a new OpenCms configuration manager.

构造器
构造器和说明
`CmsConfigurationManager(java.lang.String baseFolder)` Creates a new OpenCms configuration manager.

方法概要

方法
限定符和类型	方法和说明
`void`	`addConfiguration(I_CmsXmlConfiguration configuration)` Adds a configuration object to the configuration manager.
`void`	`addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)` Adds a configuration parameter to this parameter configurable class instance.
`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.
`org.dom4j.Document`	`generateXml(I_CmsXmlConfiguration configuration)` Creates the XML document build from the provided configuration.
`java.io.File`	`getBackupFolder()` Returns the backup folder.
`CmsParameterConfiguration`	`getConfiguration()` Returns the properties read from `opencms.properties`.
`I_CmsXmlConfiguration`	`getConfiguration(java.lang.Class<?> clazz)` Returns a specific configuration from the list of initialized configurations.
`java.util.List<I_CmsXmlConfiguration>`	`getConfigurations()` Returns the list of all initialized configurations.
`java.lang.String`	`getDtdFilename()` Returns the name of the DTD file for this XML configuration, e.g.
`java.lang.String`	`getDtdSystemLocation()` Returns the internal system location of the DTD file for this XML configuration, e.g.
`java.lang.String`	`getDtdUrlPrefix()` Returns the external system id prefix of the DTD file for this XML configuration, e.g.
`java.lang.String`	`getXmlFileName()` Returns the name of the XML input file for this configuration, e.g.
`void`	`initConfiguration()` Initializes a configuration after all parameters have been added.
`void`	`loadXmlConfiguration()` Loads the OpenCms configuration from the given XML file.
`void`	`setConfiguration(CmsParameterConfiguration propertyConfiguration)` Sets the configuration read from the `opencms.properties`.
`void`	`writeConfiguration(java.lang.Class<?> clazz)` Writes the XML configuration for the provided configuration instance.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DEFAULT_DTD_LOCATION
```
public static final java.lang.String DEFAULT_DTD_LOCATION
```
    The location of the OpenCms configuration DTD if the default prefix is the system ID.
    
    另请参阅:
    常量字段值
  - DEFAULT_DTD_PREFIX
```
public static final java.lang.String DEFAULT_DTD_PREFIX
```
    The default prefix for the OpenCms configuration DTD.
    
    另请参阅:
    常量字段值
  - DEFAULT_XML_FILE_NAME
```
public static final java.lang.String DEFAULT_XML_FILE_NAME
```
    The name of the default XML file for this configuration.
    
    另请参阅:
    常量字段值
  - DTD_FILE_NAME
```
public static final java.lang.String DTD_FILE_NAME
```
    The name of the DTD file for this configuration.
    
    另请参阅:
    常量字段值
  - N_ROOT
```
public static final java.lang.String N_ROOT
```
    The "opencms" root node of the XML configuration.
    
    另请参阅:
    常量字段值
  - POSTFIX_ORI
```
public static final java.lang.String POSTFIX_ORI
```
    Postfix for original configuration files.
    
    另请参阅:
    常量字段值
  - N_CONFIG
```
protected static final java.lang.String N_CONFIG
```
    The config node.
    
    另请参阅:
    常量字段值
  - N_CONFIGURATION
```
protected static final java.lang.String N_CONFIGURATION
```
    The configurations node.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsConfigurationManager
```
public CmsConfigurationManager(java.lang.String baseFolder)
```
    Creates a new OpenCms configuration manager.
    
    参数:
    baseFolder - base folder where XML configurations to load are located
- 方法详细资料
  - addConfiguration
```
public void addConfiguration(I_CmsXmlConfiguration configuration)
```
    Adds a configuration object to the configuration manager.
    
    参数:
    configuration - the configuration to add
  - addConfigurationParameter
```
public void addConfigurationParameter(java.lang.String paramName,
                             java.lang.String paramValue)
```
    从接口复制的说明: I_CmsConfigurationParameterHandler
    
    Adds a configuration parameter to this parameter configurable class instance.
    
    指定者:
    
    addConfigurationParameter 在接口中 I_CmsConfigurationParameterHandler
    
    参数:
    paramName - the name of the parameter
    paramValue - the value for the parameter
    另请参阅:
    I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)
  - addXmlDigesterRules
```
public void addXmlDigesterRules(org.apache.commons.digester.Digester digester)
```
    从接口复制的说明: I_CmsXmlConfiguration
    
    Digests an XML node and creates an instance of this configurable class.
    
    指定者:
    
    addXmlDigesterRules 在接口中 I_CmsXmlConfiguration
    
    参数:
    digester - the digester to use
    另请参阅:
    I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester.Digester)
  - generateXml
```
public org.dom4j.Element generateXml(org.dom4j.Element parent)
```
    从接口复制的说明: I_CmsXmlConfiguration
    
    Generates the XML element for this configurable class.
    
    指定者:
    
    generateXml 在接口中 I_CmsXmlConfiguration
    
    参数:
    parent - the parent element in the XML tree
    
    返回:
    the XML element for this configurable class
    另请参阅:
    I_CmsXmlConfiguration.generateXml(org.dom4j.Element)
  - generateXml
```
public org.dom4j.Document generateXml(I_CmsXmlConfiguration configuration)
```
    Creates the XML document build from the provided configuration.
    
    参数:
    configuration - the configuration to build the XML for
    
    返回:
    the XML document build from the provided configuration
  - getBackupFolder
```
public java.io.File getBackupFolder()
```
    Returns the backup folder.
    
    返回:
    the backup folder
  - getConfiguration
```
public CmsParameterConfiguration getConfiguration()
```
    Returns the properties read from opencms.properties.
    
    指定者:
    
    getConfiguration 在接口中 I_CmsConfigurationParameterHandler
    
    返回:
    the parameters of this configurable class instance, or null if the class does not need any parameters
    另请参阅:
    setConfiguration(CmsParameterConfiguration), I_CmsConfigurationParameterHandler.getConfiguration()
  - getConfiguration
```
public I_CmsXmlConfiguration getConfiguration(java.lang.Class<?> clazz)
```
    Returns a specific configuration from the list of initialized configurations.
    
    参数:
    clazz - the configuration class that should be returned
    
    返回:
    the initialized configuration class instance, or null if this is not found
  - getConfigurations
```
public java.util.List<I_CmsXmlConfiguration> getConfigurations()
```
    Returns the list of all initialized configurations.
    
    返回:
    the list of all initialized configurations
  - getDtdFilename
```
public java.lang.String getDtdFilename()
```
    从接口复制的说明: I_CmsXmlConfiguration
    
    Returns the name of the DTD file for this XML configuration, e.g. opencms-configuration.dtd.
    
    指定者:
    
    getDtdFilename 在接口中 I_CmsXmlConfiguration
    
    返回:
    the name of the DTD file for this XML configuration
    另请参阅:
    I_CmsXmlConfiguration.getDtdFilename()
  - getDtdSystemLocation
```
public java.lang.String getDtdSystemLocation()
```
    从接口复制的说明: I_CmsXmlConfiguration
    
    Returns the internal system location of the DTD file for this XML configuration, e.g. org/opencms/configuration/.
    If this is not null, then the DTD is not read through the web URL, but an internal name resolution is added that resolves the system id of the DTD to I_CmsXmlConfiguration.getDtdSystemLocation() + I_CmsXmlConfiguration.getDtdUrlPrefix().
    
    指定者:
    
    getDtdSystemLocation 在接口中 I_CmsXmlConfiguration
    
    返回:
    the system location of the DTD file for this XML configuration
    另请参阅:
    I_CmsXmlConfiguration.getDtdSystemLocation()
  - getDtdUrlPrefix
```
public java.lang.String getDtdUrlPrefix()
```
    从接口复制的说明: I_CmsXmlConfiguration
    
    Returns the external system id prefix of the DTD file for this XML configuration, e.g. http://www.opencms.org/dtd/6.0/.
    The full system id for the DTD is calculated like this: I_CmsXmlConfiguration.getDtdSystemLocation() + I_CmsXmlConfiguration.getDtdUrlPrefix().
    
    指定者:
    
    getDtdUrlPrefix 在接口中 I_CmsXmlConfiguration
    
    返回:
    the system id prefix of the DTD file for this XML configuration
    另请参阅:
    I_CmsXmlConfiguration.getDtdUrlPrefix()
  - getXmlFileName
```
public java.lang.String getXmlFileName()
```
    从接口复制的说明: I_CmsXmlConfiguration
    
    Returns the name of the XML input file for this configuration, e.g. opencms.xml.
    
    指定者:
    
    getXmlFileName 在接口中 I_CmsXmlConfiguration
    
    返回:
    the name of the XML input file for this configuration
    另请参阅:
    I_CmsXmlConfiguration.getXmlFileName()
  - initConfiguration
```
public void initConfiguration()
```
    从接口复制的说明: I_CmsConfigurationParameterHandler
    
    Initializes a configuration after all parameters have been added.
    
    指定者:
    
    initConfiguration 在接口中 I_CmsConfigurationParameterHandler
    
    另请参阅:
    I_CmsConfigurationParameterHandler.initConfiguration()
  - loadXmlConfiguration
```
public void loadXmlConfiguration()
                          throws org.xml.sax.SAXException,
                                 java.io.IOException
```
    Loads the OpenCms configuration from the given XML file.
    
    抛出:
    
    org.xml.sax.SAXException - in case of XML parse errors
    
    java.io.IOException - in case of file IO errors
  - setConfiguration
```
public void setConfiguration(CmsParameterConfiguration propertyConfiguration)
```
    Sets the configuration read from the opencms.properties.
    
    参数:
    propertyConfiguration - the configuration read from the opencms.properties
    另请参阅:
    getConfiguration()
  - writeConfiguration
```
public void writeConfiguration(java.lang.Class<?> clazz)
                        throws java.io.IOException,
                               CmsConfigurationException
```
    Writes the XML configuration for the provided configuration instance.
    
    参数:
    clazz - the configuration class to write the XML for
    
    抛出:
    
    java.io.IOException - in case of I/O errors while writing
    
    CmsConfigurationException - if the given class is not a valid configuration class

类 CmsConfigurationManager

字段概要

从接口继承的字段 org.opencms.configuration.I_CmsXmlConfiguration

从接口继承的字段 org.opencms.configuration.I_CmsConfigurationParameterHandler

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT_DTD_LOCATION

DEFAULT_DTD_PREFIX

DEFAULT_XML_FILE_NAME

DTD_FILE_NAME

N_ROOT

POSTFIX_ORI

N_CONFIG

N_CONFIGURATION

构造器详细资料

CmsConfigurationManager

方法详细资料

addConfiguration

addConfigurationParameter

addXmlDigesterRules

generateXml

generateXml

getBackupFolder

getConfiguration

getConfiguration

getConfigurations

getDtdFilename

getDtdSystemLocation

getDtdUrlPrefix

getXmlFileName

initConfiguration

loadXmlConfiguration

setConfiguration

writeConfiguration