org.opencms.configuration
Interface I_CmsXmlConfiguration

All Superinterfaces:

I_CmsConfigurationParameterHandler

All Known Implementing Classes:

A_CmsXmlConfiguration, CmsConfigurationManager, CmsImportExportConfiguration, CmsModuleConfiguration, CmsSearchConfiguration, CmsSystemConfiguration, CmsVfsConfiguration, CmsWorkplaceConfiguration

public interface I_CmsXmlConfiguration
extends I_CmsConfigurationParameterHandler

Each configurable element in OpenCms must implement this interface.

Since:

6.0.0

Version:

$Revision: 1.27 $

Author:

Alexander Kandzior

Field Summary

static java.lang.String	A_ALIAS The "alias" attribute.
static java.lang.String	A_CLASS The "class" attribute.
static java.lang.String	A_COUNT The "count" attribute.
static java.lang.String	A_DEFAULT The "default" attribute.
static java.lang.String	A_DESTINATION The "destination" attribute.
static java.lang.String	A_ENABLED The "enabled" attibute.
static java.lang.String	A_FROM The "from" attribute.
static java.lang.String	A_HANDLER The "handler" attribute.
static java.lang.String	A_ICON The "icon" attribute.
static java.lang.String	A_ID The "id" attribute.
static java.lang.String	A_KEY The "key" attribute.
static java.lang.String	A_NAME The "name" attribute.
static java.lang.String	A_ORDER The "order" attribute.
static java.lang.String	A_PASSWORD The "password" attribute.
static java.lang.String	A_PORT The "protocol" attribute.
static java.lang.String	A_PROTOCOL The "protocol" attribute.
static java.lang.String	A_SUFFIX The suffix attribute.
static java.lang.String	A_TO The "to" attribute.
static java.lang.String	A_TYPE The "type" attribute.
static java.lang.String	A_URI The "uri" attribute.
static java.lang.String	A_USER The "user" attribute.
static java.lang.String	A_VALUE The "value" attribute.
static java.lang.String	N_EXPORTPOINT Individual export point node.
static java.lang.String	N_EXPORTPOINTS Export points master node.
static java.lang.String	N_NAME An individual name node.
static java.lang.String	N_PARAM The "param" node name for generic parameters.
static java.lang.String	N_PROPERTY An individual property node.
static java.lang.String	N_RESOURCE An individual resource node.
static java.lang.String	N_SITE An individual site node.
static java.lang.String	N_VALUE An individual value node.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

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.
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.

Methods inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

addConfigurationParameter, getConfiguration, initConfiguration

Field Detail

A_ALIAS

static final java.lang.String A_ALIAS

The "alias" attribute.

See Also:

Constant Field Values

A_CLASS

static final java.lang.String A_CLASS

The "class" attribute.

See Also:

Constant Field Values

A_COUNT

static final java.lang.String A_COUNT

The "count" attribute.

See Also:

Constant Field Values

A_DEFAULT

static final java.lang.String A_DEFAULT

The "default" attribute.

See Also:

Constant Field Values

A_DESTINATION

static final java.lang.String A_DESTINATION

The "destination" attribute.

See Also:

Constant Field Values

A_ENABLED

static final java.lang.String A_ENABLED

The "enabled" attibute.

See Also:

Constant Field Values

A_FROM

static final java.lang.String A_FROM

The "from" attribute.

See Also:

Constant Field Values

A_HANDLER

static final java.lang.String A_HANDLER

The "handler" attribute.

See Also:

Constant Field Values

A_ICON

static final java.lang.String A_ICON

The "icon" attribute.

See Also:

Constant Field Values

A_ID

static final java.lang.String A_ID

The "id" attribute.

See Also:

Constant Field Values

A_KEY

static final java.lang.String A_KEY

The "key" attribute.

See Also:

Constant Field Values

A_NAME

static final java.lang.String A_NAME

The "name" attribute.

See Also:

Constant Field Values

A_ORDER

static final java.lang.String A_ORDER

The "order" attribute.

See Also:

Constant Field Values

A_PASSWORD

static final java.lang.String A_PASSWORD

The "password" attribute.

See Also:

Constant Field Values

A_PROTOCOL

static final java.lang.String A_PROTOCOL

The "protocol" attribute.

See Also:

Constant Field Values

A_PORT

static final java.lang.String A_PORT

The "protocol" attribute.

See Also:

Constant Field Values

A_SUFFIX

static final java.lang.String A_SUFFIX

The suffix attribute.

See Also:

Constant Field Values

A_TO

static final java.lang.String A_TO

The "to" attribute.

See Also:

Constant Field Values

A_TYPE

static final java.lang.String A_TYPE

The "type" attribute.

See Also:

Constant Field Values

A_URI

static final java.lang.String A_URI

The "uri" attribute.

See Also:

Constant Field Values

A_USER

static final java.lang.String A_USER

The "user" attribute.

See Also:

Constant Field Values

A_VALUE

static final java.lang.String A_VALUE

The "value" attribute.

See Also:

Constant Field Values

N_EXPORTPOINT

static final java.lang.String N_EXPORTPOINT

Individual export point node.

See Also:

Constant Field Values

N_EXPORTPOINTS

static final java.lang.String N_EXPORTPOINTS

Export points master node.

See Also:

Constant Field Values

N_NAME

static final java.lang.String N_NAME

An individual name node.

See Also:

Constant Field Values

N_PARAM

static final java.lang.String N_PARAM

The "param" node name for generic parameters.

See Also:

Constant Field Values

N_PROPERTY

static final java.lang.String N_PROPERTY

An individual property node.

See Also:

Constant Field Values

N_RESOURCE

static final java.lang.String N_RESOURCE

An individual resource node.

See Also:

Constant Field Values

N_SITE

static final java.lang.String N_SITE

An individual site node.

See Also:

Constant Field Values

N_VALUE

static final java.lang.String N_VALUE

An individual value node.

See Also:

Constant Field Values

Method Detail

addXmlDigesterRules

void addXmlDigesterRules(org.apache.commons.digester.Digester digester)

Digests an XML node and creates an instance of this configurable class.

Parameters:

digester - the digester to use

generateXml

org.dom4j.Element generateXml(org.dom4j.Element parent)

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

getDtdFilename

java.lang.String getDtdFilename()

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:

getDtdSystemLocation(), getDtdUrlPrefix()

getDtdSystemLocation

java.lang.String getDtdSystemLocation()

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 getDtdSystemLocation() + getDtdUrlPrefix().

Returns:

the system location of the DTD file for this XML configuration

See Also:

getDtdUrlPrefix(), getDtdFilename()

getDtdUrlPrefix

java.lang.String getDtdUrlPrefix()

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: getDtdSystemLocation() + getDtdUrlPrefix().

Returns:

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

See Also:

getDtdSystemLocation(), getDtdFilename()

getXmlFileName

java.lang.String getXmlFileName()

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

Returns:

the name of the XML input file for this configuration