Package org.opencms.configuration
Class CmsImportExportConfiguration
java.lang.Object
org.opencms.configuration.A_CmsXmlConfiguration
org.opencms.configuration.CmsImportExportConfiguration
- All Implemented Interfaces:
I_CmsConfigurationParameterHandler
,I_CmsXmlConfiguration
Import / export master configuration class.
- Since:
- 6.0.0
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The name of the DTD for this configuration.static final String
The name of the default XML file for this configuration.static final String
The node name of the column node.static final String
The node name of the columns node.static final String
Node that indicates page conversion.static final String
The node name of the export sub-configuration.static final String
The node name of the defaultexporttimestamps sub-configuration.static final String
The node name of the resourcetype sub-configuration.static final String
The node name of the timestamp sub-configuration.static final String
The main configuration node for the extended html import.static final String
The node name of the html import destination node.static final String
The node name of the html import download gallery node.static final String
The node name of the html import template node.static final String
The node name of the html import encoding node.static final String
The node name of the html import image gallery node.static final String
The node name of the html import galleries node.static final String
The node name of the html import image gallery node.static final String
The node name of the html import input node.static final String
The node name of the html import overwritefiles node.static final String
The node name of the html import locale node.static final String
The node name of the html import overwritefiles node.static final String
The node name of the html import pattern node.static final String
The node name of the html import end pattern node.static final String
The node name of the html import start pattern node.static final String
The node name of the html import settings node.static final String
The node name of the html import template node.static final String
filetranslations node name.static final String
The node name of the repository filter node.static final String
Node that contains a list of properties ignored during import.static final String
The import immutable resources node.static final String
The node name of the import sub-configuration.static final String
The main configuration node name.static final String
The node name of an individual import/export handler.static final String
Master node for import/export handlers.static final String
The node name of an individual import version class.static final String
Master node for import version class names.static final String
The node name of the static export handler node.static final String
Node the contains an optional URL of old web application.static final String
The import overwrite node name.static final String
The node name of the repository params node.static final String
An individual principal translation node.static final String
The principal translation node.static final String
The node name of the column node.static final String
The node name of the repository filter regex node.static final String
The node name of the repositories node.static final String
The node name of the repository node.static final String
The node name of the separator node.static final String
The main configuration node for static export name.static final String
The node name of the static export acceptcharset node.static final String
The node name of the static export acceptlanguage node.static final String
The node name of the static export default node.static final String
The node name of the static export defualtsuffix node.static final String
The node name of the static export rule description nodes.static final String
The node name of the static export export-rule export node.static final String
The node name of the static export exportbackups node.static final String
The node name of the static export exportheaders node.static final String
The node name of the static export exportpath node.static final String
The node name of the static export export-rule node.static final String
The node name of the static export export-rules node.static final String
The node name of the static export exporturl node.static final String
The node name of the static export exportworkpath node.static final String
The node name of the static export handler node.static final String
The node name of the static export header node.static final String
The node name of the static export export-rule modified node.static final String
The node name of the static export rule name nodes.static final String
The node name of the static export plainoptimization node.static final String
The node name of the static export regex node.static final String
The node name of the static export related-system-res node.static final String
The node name of the static export relativelinks node.static final String
The node name of the static export remoteaddr node.static final String
The node name of the static export rendersettings node.static final String
The node name of the static export requestheaders node.static final String
The node name of the static export resourcestorender node.static final String
The node name of the static export rfx-prefix node.static final String
The node name of the static export rfx-rule node.static final String
The node name of the static export rfx-rules node.static final String
The node name of the static export rfx-rule source node.static final String
The node name of the static export suffix node.static final String
The node name of the static export testresource node.static final String
The node name of the static export export-rule export uri node.static final String
The node name of the static export vfx-prefix node.static final String
The temporary export point path node.static final String
translation node name.static final String
The node name of the user csv export node.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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addProtectedExportPoint
(String uri, String destination) Adds an protected export point.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.Returns the name of the DTD file for this XML configuration, e.g.Returns the initialized import/export manager.Returns the initialized repository manager.Returns the initialized static export manager.void
Will be called when configuration of this object is finished.protected void
Initializes member variables.void
setExtendedHtmlImportManager
(CmsExtendedHtmlImportDefault extendedHtmlImportManager) Sets the extendedHtmlImportManager.void
Sets the generated import/export manager.void
setProtectedExportPath
(String exportPath) Sets the protected export path.void
setRepositoryManager
(CmsRepositoryManager manager) Sets the generated repository manager.void
Sets the generated static export manager.void
setUserExportSettings
(CmsUserExportSettings userExportSettings) Sets the user settings for export and import.Methods inherited from class org.opencms.configuration.A_CmsXmlConfiguration
addConfigurationParameter, getConfiguration, getDtdSystemLocation, getDtdUrlPrefix, getXmlFileName, initConfiguration, setXmlFileName
-
Field Details
-
CONFIGURATION_DTD_NAME
The name of the DTD for this configuration.- See Also:
-
DEFAULT_XML_FILE_NAME
The name of the default XML file for this configuration.- See Also:
-
N_COLUMN
The node name of the column node.- See Also:
-
N_COLUMNS
The node name of the columns node.- See Also:
-
N_CONVERT
Node that indicates page conversion.- See Also:
-
N_EXPORT
The node name of the export sub-configuration.- See Also:
-
N_EXPORT_DEFAULTTIMESTAMPMODES
The node name of the defaultexporttimestamps sub-configuration.- See Also:
-
N_EXPORT_RESOURCETYPENAME
The node name of the resourcetype sub-configuration.- See Also:
-
N_EXPORT_TIMESTAMPMODE
The node name of the timestamp sub-configuration.- See Also:
-
N_EXTHTMLIMPORT
The main configuration node for the extended html import.- See Also:
-
N_EXTHTMLIMPORT_DESTINATION
The node name of the html import destination node.- See Also:
-
N_EXTHTMLIMPORT_DOWNLOAD
The node name of the html import download gallery node.- See Also:
-
N_EXTHTMLIMPORT_ELEMENT
The node name of the html import template node.- See Also:
-
N_EXTHTMLIMPORT_ENCODING
The node name of the html import encoding node.- See Also:
-
N_EXTHTMLIMPORT_EXTERNALLINK
The node name of the html import image gallery node.- See Also:
-
N_EXTHTMLIMPORT_GALLERIES
The node name of the html import galleries node.- See Also:
-
N_EXTHTMLIMPORT_IMAGE
The node name of the html import image gallery node.- See Also:
-
N_EXTHTMLIMPORT_INPUT
The node name of the html import input node.- See Also:
-
N_EXTHTMLIMPORT_KEEPBROKENLINKS
The node name of the html import overwritefiles node.- See Also:
-
N_EXTHTMLIMPORT_LOCALE
The node name of the html import locale node.- See Also:
-
N_EXTHTMLIMPORT_OVERWRITE
The node name of the html import overwritefiles node.- See Also:
-
N_EXTHTMLIMPORT_PATTERN
The node name of the html import pattern node.- See Also:
-
N_EXTHTMLIMPORT_PATTERN_END
The node name of the html import end pattern node.- See Also:
-
N_EXTHTMLIMPORT_PATTERN_START
The node name of the html import start pattern node.- See Also:
-
N_EXTHTMLIMPORT_SETTINGS
The node name of the html import settings node.- See Also:
-
N_EXTHTMLIMPORT_TEMPLATE
The node name of the html import template node.- See Also:
-
N_FILETRANSLATIONS
filetranslations node name.- See Also:
-
N_FILTER
The node name of the repository filter node.- See Also:
-
N_IGNOREDPROPERTIES
Node that contains a list of properties ignored during import.- See Also:
-
N_IMMUTABLES
The import immutable resources node.- See Also:
-
N_IMPORT
The node name of the import sub-configuration.- See Also:
-
N_IMPORTEXPORT
The main configuration node name.- See Also:
-
N_IMPORTEXPORTHANDLER
The node name of an individual import/export handler.- See Also:
-
N_IMPORTEXPORTHANDLERS
Master node for import/export handlers.- See Also:
-
N_IMPORTVERSION
The node name of an individual import version class.- See Also:
-
N_IMPORTVERSIONS
Master node for import version class names.- See Also:
-
N_LINKSUBSTITUTION_HANDLER
The node name of the static export handler node.- See Also:
-
N_OLDWEBAPPURL
Node the contains an optional URL of old web application.- See Also:
-
N_OVERWRITE
The import overwrite node name.- See Also:
-
N_PARAMS
The node name of the repository params node.- See Also:
-
N_PRINCIPALTRANSLATION
An individual principal translation node.- See Also:
-
N_PRINCIPALTRANSLATIONS
The principal translation node.- See Also:
-
N_PROTECTED_EXPORT
The node name of the column node.- See Also:
-
N_REGEX
The node name of the repository filter regex node.- See Also:
-
N_REPOSITORIES
The node name of the repositories node.- See Also:
-
N_REPOSITORY
The node name of the repository node.- See Also:
-
N_SEPARATOR
The node name of the separator node.- See Also:
-
N_STATICEXPORT
The main configuration node for static export name.- See Also:
-
N_STATICEXPORT_ACCEPTCHARSET
The node name of the static export acceptcharset node.- See Also:
-
N_STATICEXPORT_ACCEPTLANGUAGE
The node name of the static export acceptlanguage node.- See Also:
-
N_STATICEXPORT_DEFAULT
The node name of the static export default node.- See Also:
-
N_STATICEXPORT_DEFAULTSUFFIXES
The node name of the static export defualtsuffix node.- See Also:
-
N_STATICEXPORT_DESCRIPTION
The node name of the static export rule description nodes.- See Also:
-
N_STATICEXPORT_EXPORT
The node name of the static export export-rule export node.- See Also:
-
N_STATICEXPORT_EXPORTBACKUPS
The node name of the static export exportbackups node.- See Also:
-
N_STATICEXPORT_EXPORTHEADERS
The node name of the static export exportheaders node.- See Also:
-
N_STATICEXPORT_EXPORTPATH
The node name of the static export exportpath node.- See Also:
-
N_STATICEXPORT_EXPORTRULE
The node name of the static export export-rule node.- See Also:
-
N_STATICEXPORT_EXPORTRULES
The node name of the static export export-rules node.- See Also:
-
N_STATICEXPORT_EXPORTURL
The node name of the static export exporturl node.- See Also:
-
N_STATICEXPORT_EXPORTWORKPATH
The node name of the static export exportworkpath node.- See Also:
-
N_STATICEXPORT_HANDLER
The node name of the static export handler node.- See Also:
-
N_STATICEXPORT_HEADER
The node name of the static export header node.- See Also:
-
N_STATICEXPORT_MODIFIED
The node name of the static export export-rule modified node.- See Also:
-
N_STATICEXPORT_NAME
The node name of the static export rule name nodes.- See Also:
-
N_STATICEXPORT_PLAINOPTIMIZATION
The node name of the static export plainoptimization node.- See Also:
-
N_STATICEXPORT_REGEX
The node name of the static export regex node.- See Also:
-
N_STATICEXPORT_RELATED_SYSTEM_RES
The node name of the static export related-system-res node.- See Also:
-
N_STATICEXPORT_RELATIVELINKS
The node name of the static export relativelinks node.- See Also:
-
N_STATICEXPORT_REMOTEADDR
The node name of the static export remoteaddr node.- See Also:
-
N_STATICEXPORT_RENDERSETTINGS
The node name of the static export rendersettings node.- See Also:
-
N_STATICEXPORT_REQUESTHEADERS
The node name of the static export requestheaders node.- See Also:
-
N_STATICEXPORT_RESOURCESTORENDER
The node name of the static export resourcestorender node.- See Also:
-
N_STATICEXPORT_RFS_PREFIX
The node name of the static export rfx-prefix node.- See Also:
-
N_STATICEXPORT_RFS_RULE
The node name of the static export rfx-rule node.- See Also:
-
N_STATICEXPORT_RFS_RULES
The node name of the static export rfx-rules node.- See Also:
-
N_STATICEXPORT_SOURCE
The node name of the static export rfx-rule source node.- See Also:
-
N_STATICEXPORT_SUFFIX
The node name of the static export suffix node.- See Also:
-
N_STATICEXPORT_TESTRESOURCE
The node name of the static export testresource node.- See Also:
-
N_STATICEXPORT_URI
The node name of the static export export-rule export uri node.- See Also:
-
N_STATICEXPORT_VFS_PREFIX
The node name of the static export vfx-prefix node.- See Also:
-
N_TEMP_EXPORTPONT_PATH
The temporary export point path node.- See Also:
-
N_TRANSLATION
translation node name.- See Also:
-
N_USERCSVEXPORT
The node name of the user csv export node.- See Also:
-
-
Constructor Details
-
CmsImportExportConfiguration
public CmsImportExportConfiguration()
-
-
Method Details
-
addProtectedExportPoint
Adds an protected export point.- Parameters:
uri
- the source URIdestination
- the export destination
-
addXmlDigesterRules
Description copied from interface:I_CmsXmlConfiguration
Digests an XML node and creates an instance of this configurable class.- Parameters:
digester
- the digester to use- See Also:
-
generateXml
Description copied from interface:I_CmsXmlConfiguration
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
- See Also:
-
getDtdFilename
Description copied from interface:I_CmsXmlConfiguration
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:
-
getImportExportManager
Returns the initialized import/export manager.- Returns:
- the initialized import/export manager
-
getRepositoryManager
Returns the initialized repository manager.- Returns:
- the initialized repository manager
-
getStaticExportManager
Returns the initialized static export manager.- Returns:
- the initialized static export manager
-
initializeFinished
Will be called when configuration of this object is finished. -
setExtendedHtmlImportManager
Sets the extendedHtmlImportManager.- Parameters:
extendedHtmlImportManager
- the extendedHtmlImportManager to set
-
setImportExportManager
Sets the generated import/export manager.- Parameters:
manager
- the import/export manager to set
-
setProtectedExportPath
Sets the protected export path.- Parameters:
exportPath
- the export path to set
-
setRepositoryManager
Sets the generated repository manager.- Parameters:
manager
- the repository manager to set
-
setStaticExportManager
Sets the generated static export manager.- Parameters:
manager
- the static export manager to set
-
setUserExportSettings
Sets the user settings for export and import.- Parameters:
userExportSettings
- the user settings for export and import
-
initMembers
Description copied from class:A_CmsXmlConfiguration
Initializes member variables.- Specified by:
initMembers
in classA_CmsXmlConfiguration
- See Also:
-