Package org.opencms.configuration

Class CmsConfigurationManager

java.lang.Object

org.opencms.configuration.CmsConfigurationManager

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

public class CmsConfigurationManager
extends 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.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DTD_LOCATION	The location of the OpenCms configuration DTD if the default prefix is the system ID.
static final String	DEFAULT_DTD_PREFIX	The default prefix for the OpenCms configuration DTD.
static final String	DEFAULT_XML_FILE_NAME	The name of the default XML file for this configuration.
static final String	DEFAULT_XSLT_FILENAME	Location of the optional XSLT file used to transform the configuration.
static final String	DTD_FILE_NAME	The name of the DTD file for this configuration.
protected static final String	N_CONFIG	The config node.
protected static final String	N_CONFIGURATION	The configurations node.
static final String	N_ROOT	The "opencms" root node of the XML configuration.
static final String	POSTFIX_ORI	Postfix for original configuration files.

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
CmsConfigurationManager(String baseFolder)	Creates a new OpenCms configuration manager.

Method Summary

Modifier and Type	Method	Description
void	addConfiguration(I_CmsXmlConfiguration configuration)	Adds a configuration object to the configuration manager.
void	addConfigurationParameter(String paramName, String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
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.
org.dom4j.Document	generateXml(I_CmsXmlConfiguration configuration)	Creates the XML document build from the provided configuration.
File	getBackupFolder()	Returns the backup folder.
CmsParameterConfiguration	getConfiguration()	Returns the properties read from opencms.properties.
I_CmsXmlConfiguration	getConfiguration(Class<?> clazz)	Returns a specific configuration from the list of initialized configurations.
List<I_CmsXmlConfiguration>	getConfigurations()	Returns the list of all initialized configurations.
String	getDtdFilename()	Returns the name of the DTD file for this XML configuration, e.g.
String	getDtdSystemLocation()	Returns the internal system location of the DTD file for this XML configuration, e.g.
String	getDtdUrlPrefix()	Returns the external system id prefix of the DTD file for this XML configuration, e.g.
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	setAdminCms(CmsObject cms)	Sets the admin CmsObject.
void	setConfiguration(CmsParameterConfiguration propertyConfiguration)	Sets the configuration read from the opencms.properties.
void	writeConfiguration(Class<?> clazz)	Writes the XML configuration for the provided configuration instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_DTD_LOCATION

public static final String DEFAULT_DTD_LOCATION

The location of the OpenCms configuration DTD if the default prefix is the system ID.

See Also:

• Constant Field Values

DEFAULT_XSLT_FILENAME

public static final String DEFAULT_XSLT_FILENAME

Location of the optional XSLT file used to transform the configuration.

See Also:

• Constant Field Values

DEFAULT_DTD_PREFIX

public static final String DEFAULT_DTD_PREFIX

The default prefix for the OpenCms configuration DTD.

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

DTD_FILE_NAME

public static final String DTD_FILE_NAME

The name of the DTD file for this configuration.

See Also:

• Constant Field Values

N_ROOT

public static final String N_ROOT

The "opencms" root node of the XML configuration.

See Also:

• Constant Field Values

POSTFIX_ORI

public static final String POSTFIX_ORI

Postfix for original configuration files.

See Also:

• Constant Field Values

N_CONFIG

protected static final String N_CONFIG

The config node.

See Also:

• Constant Field Values

N_CONFIGURATION

protected static final String N_CONFIGURATION

The configurations node.

See Also:

• Constant Field Values

Constructor Details

CmsConfigurationManager

public CmsConfigurationManager(String baseFolder)

Creates a new OpenCms configuration manager.

Parameters:

baseFolder - base folder where XML configurations to load are located

Method Details

addConfiguration

public void addConfiguration(I_CmsXmlConfiguration configuration)

Adds a configuration object to the configuration manager.

Parameters:

configuration - the configuration to add

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

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

• I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

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.

Specified by:

addXmlDigesterRules in interface I_CmsXmlConfiguration

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.

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)

generateXml

public org.dom4j.Document generateXml(I_CmsXmlConfiguration configuration)

Creates the XML document build from the provided configuration.

Parameters:

configuration - the configuration to build the XML for

Returns:

the XML document build from the provided configuration

getBackupFolder

public File getBackupFolder()

Returns the backup folder.

Returns:

the backup folder

getConfiguration

public CmsParameterConfiguration getConfiguration()

Returns the properties read from opencms.properties.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

• setConfiguration(CmsParameterConfiguration)
• I_CmsConfigurationParameterHandler.getConfiguration()

getConfiguration

public I_CmsXmlConfiguration getConfiguration(Class<?> clazz)

Returns a specific configuration from the list of initialized configurations.

Parameters:

clazz - the configuration class that should be returned

Returns:

the initialized configuration class instance, or null if this is not found

getConfigurations

public List<I_CmsXmlConfiguration> getConfigurations()

Returns the list of all initialized configurations.

Returns:

the list of all initialized configurations

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

getDtdSystemLocation

public String getDtdSystemLocation()

Description copied from interface: 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().

Specified by:

getDtdSystemLocation in interface I_CmsXmlConfiguration

Returns:

the system location of the DTD file for this XML configuration

See Also:

• I_CmsXmlConfiguration.getDtdSystemLocation()

getDtdUrlPrefix

public String getDtdUrlPrefix()

Description copied from interface: 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().

Specified by:

getDtdUrlPrefix in interface I_CmsXmlConfiguration

Returns:

the system id prefix of the DTD file for this XML configuration

See Also:

• I_CmsXmlConfiguration.getDtdUrlPrefix()

getXmlFileName

public String getXmlFileName()

Description copied from interface: I_CmsXmlConfiguration

Returns the name of the XML input file for this configuration, e.g. opencms.xml.

Specified by:

getXmlFileName in interface I_CmsXmlConfiguration

Returns:

the name of the XML input file for this configuration

See Also:

• I_CmsXmlConfiguration.getXmlFileName()

initConfiguration

public void initConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()

loadXmlConfiguration

public void loadXmlConfiguration()
                          throws SAXException,
IOException

Loads the OpenCms configuration from the given XML file.

Throws:

SAXException - in case of XML parse errors

IOException - in case of file IO errors

setAdminCms

public void setAdminCms(CmsObject cms)

Sets the admin CmsObject.

Parameters:

cms - the admin CmsObject

setConfiguration

public void setConfiguration(CmsParameterConfiguration propertyConfiguration)

Sets the configuration read from the opencms.properties.

Parameters:

propertyConfiguration - the configuration read from the opencms.properties

See Also:

• getConfiguration()

writeConfiguration

public void writeConfiguration(Class<?> clazz)
                        throws IOException,
CmsConfigurationException

Writes the XML configuration for the provided configuration instance.

Parameters:

clazz - the configuration class to write the XML for

Throws:

IOException - in case of I/O errors while writing

CmsConfigurationException - if the given class is not a valid configuration class