Package org.opencms.configuration
Class CmsModuleConfiguration
- java.lang.Object
-
- org.opencms.configuration.A_CmsXmlConfiguration
-
- org.opencms.configuration.CmsModuleConfiguration
-
- All Implemented Interfaces:
I_CmsConfigurationParameterHandler
,I_CmsXmlConfiguration
public class CmsModuleConfiguration extends A_CmsXmlConfiguration
Modules configuration class.- Since:
- 6.0.0
-
-
Field Summary
Fields Modifier and Type Field Description 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_MODULES
The node name for the modules top node.-
Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD
-
Fields inherited from interface org.opencms.configuration.I_CmsXmlConfiguration
A_ALIAS, A_CLASS, A_COUNT, A_DEFAULT, A_DESTINATION, A_ENABLED, A_FROM, A_HANDLER, A_ICON, A_ID, A_KEY, A_MODE, A_NAME, A_ORDER, A_PASSWORD, A_PORT, A_PROTOCOL, A_SUFFIX, A_TO, A_TYPE, A_URI, A_USER, A_VALUE, N_EXPORTPOINT, N_EXPORTPOINTS, N_NAME, N_PARAM, N_PROPERTY, N_RESOURCE, N_SITE, N_VALUE
-
-
Constructor Summary
Constructors Constructor Description CmsModuleConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addXmlDigesterRules(org.apache.commons.digester3.Digester digester)
Digests an XML node and creates an instance of this configurable class.org.dom4j.Element
generateXml(org.dom4j.Element parent)
Generates the XML element for this configurable class.java.lang.String
getDtdFilename()
Returns the name of the DTD file for this XML configuration, e.g.CmsModuleManager
getModuleManager()
Returns the configured module manager.void
initializeFinished()
Will be called when configuration of this object is finished.protected void
initMembers()
Initializes member variables.void
setModule(CmsModuleXmlHandler moduleHandler)
Adds a new module to the list of configured modules.-
Methods inherited from class org.opencms.configuration.A_CmsXmlConfiguration
addConfigurationParameter, getConfiguration, getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName, initConfiguration, setXmlFileName
-
-
-
-
Field Detail
-
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_MODULES
public static final java.lang.String N_MODULES
The node name for the modules top node.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsModuleConfiguration
public CmsModuleConfiguration()
-
-
Method Detail
-
addXmlDigesterRules
public void addXmlDigesterRules(org.apache.commons.digester3.Digester digester)
Description copied from interface:I_CmsXmlConfiguration
Digests an XML node and creates an instance of this configurable class.- Parameters:
digester
- the digester to use- See Also:
I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester3.Digester)
-
generateXml
public org.dom4j.Element generateXml(org.dom4j.Element parent)
Description copied from interface:I_CmsXmlConfiguration
Generates the XML element for this configurable class.- Parameters:
parent
- the parent element in the XML tree- Returns:
- the XML element for this configurable class
- See Also:
I_CmsXmlConfiguration.generateXml(org.dom4j.Element)
-
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()
-
getModuleManager
public CmsModuleManager getModuleManager()
Returns the configured module manager.- Returns:
- the configured module manager
-
initializeFinished
public void initializeFinished()
Will be called when configuration of this object is finished.
-
setModule
public void setModule(CmsModuleXmlHandler moduleHandler)
Adds a new module to the list of configured modules.- Parameters:
moduleHandler
- contains the imported module
-
initMembers
protected void initMembers()
Description copied from class:A_CmsXmlConfiguration
Initializes member variables.- Specified by:
initMembers
in classA_CmsXmlConfiguration
- See Also:
A_CmsXmlConfiguration.initMembers()
-
-