org.opencms.configuration
Class CmsImportExportConfiguration

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

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

public class CmsImportExportConfiguration
extends A_CmsXmlConfiguration
implements I_CmsXmlConfiguration

Import / export master configuration class.

Since:

6.0.0

Version:

$Revision: 1.25 $

Author:

Alexander Kandzior

Field Summary

static String	CONFIGURATION_DTD_NAME The name of the DTD for this configuration.
static String	DEFAULT_XML_FILE_NAME The name of the default XML file for this configuration.
protected static String	N_CONVERT Node that indicates page conversion.
protected static String	N_IGNOREDPROPERTIES Node that contains a list of properties ignored during import.
protected static String	N_IMMUTABLES The import immutable resources node.
protected static String	N_IMPORT The node name of the import subconfiguration.
protected static String	N_IMPORTEXPORT The main configuration node name.
protected static String	N_IMPORTEXPORTHANDLER The node name of an individual import/export handler.
protected static String	N_IMPORTEXPORTHANDLERS Master node for import/export handlers.
protected static String	N_IMPORTVERSION The node name of an individual import version class.
protected static String	N_IMPORTVERSIONS Master node for import version class names.
protected static String	N_OLDWEBAPPURL Node the contains an optional URL of old web application.
protected static String	N_OVERWRITE The import overwrite node name.
protected static String	N_PRINCIPALTRANSLATION An individual principal translation node.
protected static String	N_PRINCIPALTRANSLATIONS The principal translation node.
protected static String	N_STATICEXPORT The main configuration node for static export name.
protected static String	N_STATICEXPORT_ACCEPTCHARSET The node name of the static export acceptcharset node.
protected static String	N_STATICEXPORT_ACCEPTLANGUAGE The node name of the static export acceptlanguage node.
protected static String	N_STATICEXPORT_DEFAULT The node name of the static export default node.
protected static String	N_STATICEXPORT_DEFAULTSUFFIXES The node name of the static export defualtsuffix node.
protected static String	N_STATICEXPORT_DESCRIPTION The node name of the static export rule description nodes.
protected static String	N_STATICEXPORT_EXPORT The node name of the static export export-rule export node.
protected static String	N_STATICEXPORT_EXPORTHEADERS The node name of the static export exportheaders node.
protected static String	N_STATICEXPORT_EXPORTPATH The node name of the static export exportpath node.
protected static String	N_STATICEXPORT_EXPORTRULE The node name of the static export export-rule node.
protected static String	N_STATICEXPORT_EXPORTRULES The node name of the static export export-rules node.
protected static String	N_STATICEXPORT_EXPORTURL The node name of the static export exporturl node.
protected static String	N_STATICEXPORT_HANDLER The node name of the static export handler node.
protected static String	N_STATICEXPORT_HEADER The node name of the static export header node.
protected static String	N_STATICEXPORT_MODIFIED The node name of the static export export-rule modified node.
protected static String	N_STATICEXPORT_NAME The node name of the static export rule name nodes.
protected static String	N_STATICEXPORT_PLAINOPTIMIZATION The node name of the static export plainoptimization node.
protected static String	N_STATICEXPORT_REGEX The node name of the static export regex node.
protected static String	N_STATICEXPORT_RELATED_SYSTEM_RES The node name of the static export related-system-res node.
protected static String	N_STATICEXPORT_RELATIVELINKS The node name of the static export relativelinks node.
protected static String	N_STATICEXPORT_REMOTEADDR The node name of the static export remoteaddr node.
protected static String	N_STATICEXPORT_RENDERSETTINGS The node name of the static export rendersettings node.
protected static String	N_STATICEXPORT_REQUESTHEADERS The node name of the static export requestheaders node.
protected static String	N_STATICEXPORT_RESOURCESTORENDER The node name of the static export resourcestorender node.
protected static String	N_STATICEXPORT_RFS_PREFIX The node name of the static export rfx-prefix node.
protected static String	N_STATICEXPORT_RFS_RULE The node name of the static export rfx-rule node.
protected static String	N_STATICEXPORT_RFS_RULES The node name of the static export rfx-rules node.
protected static String	N_STATICEXPORT_SOURCE The node name of the static export rfx-rule source node.
protected static String	N_STATICEXPORT_SUFFIX The node name of the static export suffix node.
protected static String	N_STATICEXPORT_TESTRESOURCE The node name of the static export testresource node.
protected static String	N_STATICEXPORT_URI The node name of the static export export-rule export uri node.
protected static String	N_STATICEXPORT_VFS_PREFIX The node name of the static export vfx-prefix node.

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

CmsImportExportConfiguration()
Public constructor, will be called by configuration manager.

Method Summary

void	addXmlDigesterRules(Digester digester) Digests an XML node and creates an instance of this configurable class.
Element	generateXml(Element parent) Generates the XML element for this configurable class.
String	getDtdFilename() Returns the name of the DTD file for this XML configuration, e.g.
CmsImportExportManager	getImportExportManager() Returns the initialized import/export manager.
CmsStaticExportManager	getStaticExportManager() Returns the initialized static export manager.
void	initializeFinished() Will be called when configuration of this object is finished.
void	setImportExportManager(CmsImportExportManager manager) Sets the generated import/export manager.
void	setStaticExportManager(CmsStaticExportManager manager) Sets the generated static export manager.

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 String CONFIGURATION_DTD_NAME

The name of the DTD for this configuration.

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

N_CONVERT

protected static final String N_CONVERT

Node that indicates page conversion.

See Also:

Constant Field Values

N_IGNOREDPROPERTIES

protected static final String N_IGNOREDPROPERTIES

Node that contains a list of properties ignored during import.

See Also:

Constant Field Values

N_IMMUTABLES

protected static final String N_IMMUTABLES

The import immutable resources node.

See Also:

Constant Field Values

N_IMPORT

protected static final String N_IMPORT

The node name of the import subconfiguration.

See Also:

Constant Field Values

N_IMPORTEXPORT

protected static final String N_IMPORTEXPORT

The main configuration node name.

See Also:

Constant Field Values

N_IMPORTEXPORTHANDLER

protected static final String N_IMPORTEXPORTHANDLER

The node name of an individual import/export handler.

See Also:

Constant Field Values

N_IMPORTEXPORTHANDLERS

protected static final String N_IMPORTEXPORTHANDLERS

Master node for import/export handlers.

See Also:

Constant Field Values

N_IMPORTVERSION

protected static final String N_IMPORTVERSION

The node name of an individual import version class.

See Also:

Constant Field Values

N_IMPORTVERSIONS

protected static final String N_IMPORTVERSIONS

Master node for import version class names.

See Also:

Constant Field Values

N_OLDWEBAPPURL

protected static final String N_OLDWEBAPPURL

Node the contains an optional URL of old web application.

See Also:

Constant Field Values

N_OVERWRITE

protected static final String N_OVERWRITE

The import overwrite node name.

See Also:

Constant Field Values

N_PRINCIPALTRANSLATION

protected static final String N_PRINCIPALTRANSLATION

An individual principal translation node.

See Also:

Constant Field Values

N_PRINCIPALTRANSLATIONS

protected static final String N_PRINCIPALTRANSLATIONS

The principal translation node.

See Also:

Constant Field Values

N_STATICEXPORT

protected static final String N_STATICEXPORT

The main configuration node for static export name.

See Also:

Constant Field Values

N_STATICEXPORT_ACCEPTCHARSET

protected static final String N_STATICEXPORT_ACCEPTCHARSET

The node name of the static export acceptcharset node.

See Also:

Constant Field Values

N_STATICEXPORT_ACCEPTLANGUAGE

protected static final String N_STATICEXPORT_ACCEPTLANGUAGE

The node name of the static export acceptlanguage node.

See Also:

Constant Field Values

N_STATICEXPORT_DEFAULT

protected static final String N_STATICEXPORT_DEFAULT

The node name of the static export default node.

See Also:

Constant Field Values

N_STATICEXPORT_DEFAULTSUFFIXES

protected static final String N_STATICEXPORT_DEFAULTSUFFIXES

The node name of the static export defualtsuffix node.

See Also:

Constant Field Values

N_STATICEXPORT_DESCRIPTION

protected static final String N_STATICEXPORT_DESCRIPTION

The node name of the static export rule description nodes.

See Also:

Constant Field Values

N_STATICEXPORT_EXPORT

protected static final String N_STATICEXPORT_EXPORT

The node name of the static export export-rule export node.

See Also:

Constant Field Values

N_STATICEXPORT_EXPORTHEADERS

protected static final String N_STATICEXPORT_EXPORTHEADERS

The node name of the static export exportheaders node.

See Also:

Constant Field Values

N_STATICEXPORT_EXPORTPATH

protected static final String N_STATICEXPORT_EXPORTPATH

The node name of the static export exportpath node.

See Also:

Constant Field Values

N_STATICEXPORT_EXPORTRULE

protected static final String N_STATICEXPORT_EXPORTRULE

The node name of the static export export-rule node.

See Also:

Constant Field Values

N_STATICEXPORT_EXPORTRULES

protected static final String N_STATICEXPORT_EXPORTRULES

The node name of the static export export-rules node.

See Also:

Constant Field Values

N_STATICEXPORT_EXPORTURL

protected static final String N_STATICEXPORT_EXPORTURL

The node name of the static export exporturl node.

See Also:

Constant Field Values

N_STATICEXPORT_HANDLER

protected static final String N_STATICEXPORT_HANDLER

The node name of the static export handler node.

See Also:

Constant Field Values

N_STATICEXPORT_HEADER

protected static final String N_STATICEXPORT_HEADER

The node name of the static export header node.

See Also:

Constant Field Values

N_STATICEXPORT_MODIFIED

protected static final String N_STATICEXPORT_MODIFIED

The node name of the static export export-rule modified node.

See Also:

Constant Field Values

N_STATICEXPORT_NAME

protected static final String N_STATICEXPORT_NAME

The node name of the static export rule name nodes.

See Also:

Constant Field Values

N_STATICEXPORT_PLAINOPTIMIZATION

protected static final String N_STATICEXPORT_PLAINOPTIMIZATION

The node name of the static export plainoptimization node.

See Also:

Constant Field Values

N_STATICEXPORT_REGEX

protected static final String N_STATICEXPORT_REGEX

The node name of the static export regex node.

See Also:

Constant Field Values

N_STATICEXPORT_RELATED_SYSTEM_RES

protected static final String N_STATICEXPORT_RELATED_SYSTEM_RES

The node name of the static export related-system-res node.

See Also:

Constant Field Values

N_STATICEXPORT_RELATIVELINKS

protected static final String N_STATICEXPORT_RELATIVELINKS

The node name of the static export relativelinks node.

See Also:

Constant Field Values

N_STATICEXPORT_REMOTEADDR

protected static final String N_STATICEXPORT_REMOTEADDR

The node name of the static export remoteaddr node.

See Also:

Constant Field Values

N_STATICEXPORT_RENDERSETTINGS

protected static final String N_STATICEXPORT_RENDERSETTINGS

The node name of the static export rendersettings node.

See Also:

Constant Field Values

N_STATICEXPORT_REQUESTHEADERS

protected static final String N_STATICEXPORT_REQUESTHEADERS

The node name of the static export requestheaders node.

See Also:

Constant Field Values

N_STATICEXPORT_RESOURCESTORENDER

protected static final String N_STATICEXPORT_RESOURCESTORENDER

The node name of the static export resourcestorender node.

See Also:

Constant Field Values

N_STATICEXPORT_RFS_PREFIX

protected static final String N_STATICEXPORT_RFS_PREFIX

The node name of the static export rfx-prefix node.

See Also:

Constant Field Values

N_STATICEXPORT_RFS_RULE

protected static final String N_STATICEXPORT_RFS_RULE

The node name of the static export rfx-rule node.

See Also:

Constant Field Values

N_STATICEXPORT_RFS_RULES

protected static final String N_STATICEXPORT_RFS_RULES

The node name of the static export rfx-rules node.

See Also:

Constant Field Values

N_STATICEXPORT_SOURCE

protected static final String N_STATICEXPORT_SOURCE

The node name of the static export rfx-rule source node.

See Also:

Constant Field Values

N_STATICEXPORT_SUFFIX

protected static final String N_STATICEXPORT_SUFFIX

The node name of the static export suffix node.

See Also:

Constant Field Values

N_STATICEXPORT_TESTRESOURCE

protected static final String N_STATICEXPORT_TESTRESOURCE

The node name of the static export testresource node.

See Also:

Constant Field Values

N_STATICEXPORT_URI

protected static final String N_STATICEXPORT_URI

The node name of the static export export-rule export uri node.

See Also:

Constant Field Values

N_STATICEXPORT_VFS_PREFIX

protected static final String N_STATICEXPORT_VFS_PREFIX

The node name of the static export vfx-prefix node.

See Also:

Constant Field Values

Constructor Detail

CmsImportExportConfiguration

public CmsImportExportConfiguration()

Public constructor, will be called by configuration manager.

Method Detail

addXmlDigesterRules

public void addXmlDigesterRules(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 Element generateXml(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 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()

getImportExportManager

public CmsImportExportManager getImportExportManager()

Returns the initialized import/export manager.

Returns:

the initialized import/export manager

getStaticExportManager

public CmsStaticExportManager getStaticExportManager()

Returns the initialized static export manager.

Returns:

the initialized static export manager

initializeFinished

public void initializeFinished()

Will be called when configuration of this object is finished.

setImportExportManager

public void setImportExportManager(CmsImportExportManager manager)

Sets the generated import/export manager.

Parameters:

manager - the import/export manager to set

setStaticExportManager

public void setStaticExportManager(CmsStaticExportManager manager)

Sets the generated static export manager.

Parameters:

manager - the static export manager to set