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.21 $
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_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_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

public static final java.lang.String A_ALIAS
The alias attribute.

See Also:
Constant Field Values

A_CLASS

public static final java.lang.String A_CLASS
The "class" attribute.

See Also:
Constant Field Values

A_COUNT

public static final java.lang.String A_COUNT
The "count" attribute.

See Also:
Constant Field Values

A_DESTINATION

public static final java.lang.String A_DESTINATION
The "destination" attribute.

See Also:
Constant Field Values

A_ENABLED

public static final java.lang.String A_ENABLED
The "enabled" attibute.

See Also:
Constant Field Values

A_FROM

public static final java.lang.String A_FROM
The "from" attribute.

See Also:
Constant Field Values

A_HANDLER

public static final java.lang.String A_HANDLER
The "handler" attribute.

See Also:
Constant Field Values

A_ICON

public static final java.lang.String A_ICON
The "icon" attribute.

See Also:
Constant Field Values

A_ID

public static final java.lang.String A_ID
The "id" attribute.

See Also:
Constant Field Values

A_KEY

public static final java.lang.String A_KEY
The "key" attribute.

See Also:
Constant Field Values

A_NAME

public static final java.lang.String A_NAME
The "name" attribute.

See Also:
Constant Field Values

A_ORDER

public static final java.lang.String A_ORDER
The "order" attribute.

See Also:
Constant Field Values

A_PASSWORD

public static final java.lang.String A_PASSWORD
The "password" attribute.

See Also:
Constant Field Values

A_PROTOCOL

public static final java.lang.String A_PROTOCOL
The "protocol" attribute.

See Also:
Constant Field Values

A_SUFFIX

public static final java.lang.String A_SUFFIX
The suffix attribute.

See Also:
Constant Field Values

A_TO

public static final java.lang.String A_TO
The "to" attribute.

See Also:
Constant Field Values

A_TYPE

public static final java.lang.String A_TYPE
The "type" attribute.

See Also:
Constant Field Values

A_URI

public static final java.lang.String A_URI
The "uri" attribute.

See Also:
Constant Field Values

A_USER

public static final java.lang.String A_USER
The "user" attribute.

See Also:
Constant Field Values

A_VALUE

public static final java.lang.String A_VALUE
The "value" attribute.

See Also:
Constant Field Values

N_EXPORTPOINT

public static final java.lang.String N_EXPORTPOINT
Individual export point node.

See Also:
Constant Field Values

N_EXPORTPOINTS

public static final java.lang.String N_EXPORTPOINTS
Export points master node.

See Also:
Constant Field Values

N_NAME

public static final java.lang.String N_NAME
An individual name node.

See Also:
Constant Field Values

N_PARAM

public static final java.lang.String N_PARAM
The "param" node name for generic parameters.

See Also:
Constant Field Values

N_PROPERTY

public static final java.lang.String N_PROPERTY
An individual property node.

See Also:
Constant Field Values

N_RESOURCE

public static final java.lang.String N_RESOURCE
An individual resource node.

See Also:
Constant Field Values

N_SITE

public static final java.lang.String N_SITE
An individual site node.

See Also:
Constant Field Values

N_VALUE

public static final java.lang.String N_VALUE
An individual value node.

See Also:
Constant Field Values
Method Detail

addXmlDigesterRules

public 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

public 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

public 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

public 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

public 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

public 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