org.opencms.configuration
Class A_CmsXmlConfiguration

java.lang.Object
  org.opencms.configuration.A_CmsXmlConfiguration

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

Direct Known Subclasses:

CmsImportExportConfiguration, CmsModuleConfiguration, CmsSearchConfiguration, CmsSystemConfiguration, CmsVfsConfiguration, CmsWorkplaceConfiguration

public abstract class A_CmsXmlConfiguration
extends Object
implements I_CmsXmlConfiguration

Abstract base implementation for xml configurations.

Since:

6.0.0

Version:

$Revision: 1.17 $

Author:

Alexander Kandzior

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsXmlConfiguration

A_ALIAS, A_CLASS, A_COUNT, 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

A_CmsXmlConfiguration()

Method Summary

void	addConfigurationParameter(String paramName, String paramValue) Adds a configuration parameter to this parameter configurable class instance.
Map	getConfiguration() Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.
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.
protected void	setXmlFileName(String fileName) Sets the file name of this XML configuration.

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

addXmlDigesterRules, generateXml, getDtdFilename

Constructor Detail

A_CmsXmlConfiguration

public A_CmsXmlConfiguration()

Method Detail

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)

getConfiguration

public Map getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the configuration of this parameter configurable class instance, or null if the class does not need to be configured.

All elements in the configuration are key, value String pairs, set using the I_CmsConfigurationParameterHandler.addConfigurationParameter(String, String) method during initialization of the loader.

Implementations will (should) not to return a direct reference to the internal configuration but just a copy of it, to avoid unwanted external manipulation.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the configuration of this resource loader, or null

See Also:

I_CmsConfigurationParameterHandler.getConfiguration()

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

setXmlFileName

protected void setXmlFileName(String fileName)

Sets the file name of this XML configuration.

Parameters:

fileName - the file name to set