org.opencms.configuration
Class CmsModuleConfiguration

java.lang.Object
  extended byorg.opencms.configuration.A_CmsXmlConfiguration
      extended byorg.opencms.configuration.CmsModuleConfiguration
All Implemented Interfaces:
I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

public class CmsModuleConfiguration
extends A_CmsXmlConfiguration
implements I_CmsXmlConfiguration

VFS master configuration class.

Since:
6.0.0
Version:
$Revision: 1.14 $
Author:
Alexander Kandzior

Field Summary
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_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_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
CmsModuleConfiguration()
          Public constructor, will be called by configuration manager.
 
Method Summary
 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.
 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.
 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
 
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
addConfigurationParameter, getConfiguration, initConfiguration
 

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()
Public constructor, will be called by configuration manager.

Method Detail

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.

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 org.dom4j.Element generateXml(org.dom4j.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)

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.

Specified by:
getDtdFilename in interface I_CmsXmlConfiguration
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