Package org.opencms.configuration

Class CmsVfsConfiguration

java.lang.Object

org.opencms.configuration.A_CmsXmlConfiguration

org.opencms.configuration.CmsVfsConfiguration

All Implemented Interfaces:

I_CmsConfigurationParameterHandler, I_CmsXmlConfiguration

public class CmsVfsConfiguration
extends A_CmsXmlConfiguration

VFS master configuration class.

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	A_ADJUST_LINKS_FOLDER	The adjust-links-folder attribute.
static final String	A_CONFIGURATION	The widget configuration attribute.
static final String	A_DEFAULTWIDGET	The widget attribute.
static final String	A_EXTENSION	The extension attribute name.
static final String	A_SOURCE	The source attribute name.
static final String	A_TARGET	The target attribute name.
static final String	CONFIGURATION_DTD_NAME	The name of the DTD for this configuration.
static final String	DEFAULT_XML_FILE_NAME	The name of the default XML file for this configuration.
static final String	N_COLLECTOR	The collector node name.
static final String	N_COLLECTORS	The collectors node name.
static final String	N_COPY_RESOURCE	The copy-resource node name.
static final String	N_COPY_RESOURCES	The copy-resources node name.
static final String	N_DEFAULTFILE	The defaultfile node name.
static final String	N_DEFAULTFILES	The defaultfiles node name.
static final String	N_FILETRANSLATIONS	File translations node name.
static final String	N_FOLDERTRANSLATIONS	Folder translations node name.
static final String	N_HTML_CONVERTER	The html-converter node name.
static final String	N_HTML_CONVERTERS	The html-converters node name.
static final String	N_LOADER	The node name of an individual resource loader.
static final String	N_MAPPING	The mapping node name.
static final String	N_MAPPINGS	The mappings node name.
static final String	N_MIMETYPE	The mimetype node name.
static final String	N_MIMETYPES	The mimetypes node name.
static final String	N_PROPERTIES	The properties node name.
static final String	N_RELATIONTYPE	The relation type node name.
static final String	N_RELATIONTYPES	The relation types node name.
static final String	N_RESOURCELOADERS	The resource loaders node name.
static final String	N_RESOURCES	The main resource node name.
static final String	N_RESOURCETYPES	The resource types node name.
static final String	N_SCHEMATYPE	The schematype node name.
static final String	N_SCHEMATYPES	The schematypes node name.
static final String	N_TRANSLATION	Individual translation node name.
static final String	N_TRANSLATIONS	The translations master node name.
static final String	N_TYPE	The node name of an individual resource type.
static final String	N_VERSIONHISTORY	The node name for the version history.
static final String	N_VFS	The main vfs configuration node name.
static final String	N_WIDGET	The widget node name.
static final String	N_WIDGET_ALIAS	The widget alias node name.
static final String	N_WIDGETS	The widgets node name.
static final String	N_XMLCONTENT	The xmlcontent node name.
static final String	N_XMLCONTENTS	The xmlcontents node name.
static final String	N_XSDTRANSLATIONS	XSD translations node name.

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

Constructors

Constructor	Description
CmsVfsConfiguration()

Method Summary

Modifier and Type	Method	Description
void	addDefaultFile(String defaultFile)	Adds a directory default file.
void	addFileTranslation(String translation)	Adds one file translation rule.
void	addFolderTranslation(String translation)	Adds one folder translation rule.
static void	addResourceTypeXmlRules(org.apache.commons.digester3.Digester digester)	Adds the resource type rules to the given digester.
void	addXmlDigesterRules(org.apache.commons.digester3.Digester digester)	Digests an XML node and creates an instance of this configurable class.
void	addXsdTranslation(String translation)	Adds one XSD translation rule.
static void	generateResourceTypeXml(org.dom4j.Element startNode, List<I_CmsResourceType> resourceTypes, boolean module)	Creates the xml output for resourcetype nodes.
org.dom4j.Element	generateXml(org.dom4j.Element parent)	Generates the XML element for this configurable class.
List<String>	getDefaultFiles()	Returns the (unmodifiable) list of configured directory default files.
String	getDtdFilename()	Returns the name of the DTD file for this XML configuration, e.g.
CmsResourceTranslator	getFileTranslator()	Returns the file resource translator that has been initialized with the configured file translation rules.
CmsResourceTranslator	getFolderTranslator()	Returns the folder resource translator that has been initialized with the configured folder translation rules.
CmsResourceManager	getResourceManager()	Returns the initialized resource manager.
CmsXmlContentTypeManager	getXmlContentTypeManager()	Returns the configured XML content type manager.
CmsResourceTranslator	getXsdTranslator()	Returns the XSD translator that has been initialized with the configured XSD translation rules.
void	initializeFinished()	Will be called when configuration of this object is finished.
protected void	initMembers()	Initializes member variables.
void	setFileTranslationEnabled(String value)	Enables or disables the file translation rules.
void	setFolderTranslationEnabled(String value)	Enables or disables the folder translation rules.
void	setResourceManager(CmsResourceManager manager)	Sets the generated resource manager.
void	setXmlContentTypeManager(CmsXmlContentTypeManager manager)	Sets the generated XML content type manager.
void	setXsdTranslationEnabled(String value)	Enables or disables the XSD translation rules.

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

Field Details

A_ADJUST_LINKS_FOLDER

public static final String A_ADJUST_LINKS_FOLDER

The adjust-links-folder attribute.

See Also:

• Constant Field Values

A_CONFIGURATION

public static final String A_CONFIGURATION

The widget configuration attribute.

See Also:

• Constant Field Values

A_DEFAULTWIDGET

public static final String A_DEFAULTWIDGET

The widget attribute.

See Also:

• Constant Field Values

A_EXTENSION

public static final String A_EXTENSION

The extension attribute name.

See Also:

• Constant Field Values

A_SOURCE

public static final String A_SOURCE

The source attribute name.

See Also:

• Constant Field Values

A_TARGET

public static final String A_TARGET

The target attribute name.

See Also:

• Constant Field Values

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_COLLECTOR

public static final String N_COLLECTOR

The collector node name.

See Also:

• Constant Field Values

N_COLLECTORS

public static final String N_COLLECTORS

The collectors node name.

See Also:

• Constant Field Values

N_COPY_RESOURCE

public static final String N_COPY_RESOURCE

The copy-resource node name.

See Also:

• Constant Field Values

N_COPY_RESOURCES

public static final String N_COPY_RESOURCES

The copy-resources node name.

See Also:

• Constant Field Values

N_DEFAULTFILE

public static final String N_DEFAULTFILE

The defaultfile node name.

See Also:

• Constant Field Values

N_DEFAULTFILES

public static final String N_DEFAULTFILES

The defaultfiles node name.

See Also:

• Constant Field Values

N_FILETRANSLATIONS

public static final String N_FILETRANSLATIONS

File translations node name.

See Also:

• Constant Field Values

N_FOLDERTRANSLATIONS

public static final String N_FOLDERTRANSLATIONS

Folder translations node name.

See Also:

• Constant Field Values

N_HTML_CONVERTER

public static final String N_HTML_CONVERTER

The html-converter node name.

See Also:

• Constant Field Values

N_HTML_CONVERTERS

public static final String N_HTML_CONVERTERS

The html-converters node name.

See Also:

• Constant Field Values

N_LOADER

public static final String N_LOADER

The node name of an individual resource loader.

See Also:

• Constant Field Values

N_MAPPING

public static final String N_MAPPING

The mapping node name.

See Also:

• Constant Field Values

N_MAPPINGS

public static final String N_MAPPINGS

The mappings node name.

See Also:

• Constant Field Values

N_MIMETYPE

public static final String N_MIMETYPE

The mimetype node name.

See Also:

• Constant Field Values

N_MIMETYPES

public static final String N_MIMETYPES

The mimetypes node name.

See Also:

• Constant Field Values

N_PROPERTIES

public static final String N_PROPERTIES

The properties node name.

See Also:

• Constant Field Values

N_RELATIONTYPE

public static final String N_RELATIONTYPE

The relation type node name.

See Also:

• Constant Field Values

N_RELATIONTYPES

public static final String N_RELATIONTYPES

The relation types node name.

See Also:

• Constant Field Values

N_RESOURCELOADERS

public static final String N_RESOURCELOADERS

The resource loaders node name.

See Also:

• Constant Field Values

N_RESOURCES

public static final String N_RESOURCES

The main resource node name.

See Also:

• Constant Field Values

N_RESOURCETYPES

public static final String N_RESOURCETYPES

The resource types node name.

See Also:

• Constant Field Values

N_SCHEMATYPE

public static final String N_SCHEMATYPE

The schematype node name.

See Also:

• Constant Field Values

N_SCHEMATYPES

public static final String N_SCHEMATYPES

The schematypes node name.

See Also:

• Constant Field Values

N_TRANSLATION

public static final String N_TRANSLATION

Individual translation node name.

See Also:

• Constant Field Values

N_TRANSLATIONS

public static final String N_TRANSLATIONS

The translations master node name.

See Also:

• Constant Field Values

N_TYPE

public static final String N_TYPE

The node name of an individual resource type.

See Also:

• Constant Field Values

N_VERSIONHISTORY

public static final String N_VERSIONHISTORY

The node name for the version history.

See Also:

• Constant Field Values

N_VFS

public static final String N_VFS

The main vfs configuration node name.

See Also:

• Constant Field Values

N_WIDGET

public static final String N_WIDGET

The widget node name.

See Also:

• Constant Field Values

N_WIDGET_ALIAS

public static final String N_WIDGET_ALIAS

The widget alias node name.

See Also:

• Constant Field Values

N_WIDGETS

public static final String N_WIDGETS

The widgets node name.

See Also:

• Constant Field Values

N_XMLCONTENT

public static final String N_XMLCONTENT

The xmlcontent node name.

See Also:

• Constant Field Values

N_XMLCONTENTS

public static final String N_XMLCONTENTS

The xmlcontents node name.

See Also:

• Constant Field Values

N_XSDTRANSLATIONS

public static final String N_XSDTRANSLATIONS

XSD translations node name.

See Also:

• Constant Field Values

Constructor Details

CmsVfsConfiguration

public CmsVfsConfiguration()

Method Details

addResourceTypeXmlRules

public static void addResourceTypeXmlRules(org.apache.commons.digester3.Digester digester)

Adds the resource type rules to the given digester.

Parameters:

digester - the digester to add the rules to

generateResourceTypeXml

public static void generateResourceTypeXml(org.dom4j.Element startNode,
 List<I_CmsResourceType> resourceTypes,
 boolean module)

Creates the xml output for resourcetype nodes.

Parameters:

startNode - the startnode to add all rescource types to

resourceTypes - the list of resource types

module - flag, signaling to add them module resource types or not

addDefaultFile

public void addDefaultFile(String defaultFile)

Adds a directory default file.

Parameters:

defaultFile - the directory default file to add

addFileTranslation

public void addFileTranslation(String translation)

Adds one file translation rule.

Parameters:

translation - the file translation rule to add

addFolderTranslation

public void addFolderTranslation(String translation)

Adds one folder translation rule.

Parameters:

translation - the folder translation rule to add

addXmlDigesterRules

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

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:

• I_CmsXmlConfiguration.addXmlDigesterRules(org.apache.commons.digester3.Digester)

addXsdTranslation

public void addXsdTranslation(String translation)

Adds one XSD translation rule.

Parameters:

translation - the XSD translation rule to add

generateXml

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

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:

• I_CmsXmlConfiguration.generateXml(org.dom4j.Element)

getDefaultFiles

public List<String> getDefaultFiles()

Returns the (unmodifiable) list of configured directory default files.

Returns:

the (unmodifiable) list of configured directory default files

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.

Returns:

the name of the DTD file for this XML configuration

See Also:

• I_CmsXmlConfiguration.getDtdFilename()

getFileTranslator

public CmsResourceTranslator getFileTranslator()

Returns the file resource translator that has been initialized with the configured file translation rules.

Returns:

the file resource translator

getFolderTranslator

public CmsResourceTranslator getFolderTranslator()

Returns the folder resource translator that has been initialized with the configured folder translation rules.

Returns:

the folder resource translator

getResourceManager

public CmsResourceManager getResourceManager()

Returns the initialized resource manager.

Returns:

the initialized resource manager

getXmlContentTypeManager

public CmsXmlContentTypeManager getXmlContentTypeManager()

Returns the configured XML content type manager.

Returns:

the configured XML content type manager

getXsdTranslator

public CmsResourceTranslator getXsdTranslator()

Returns the XSD translator that has been initialized with the configured XSD translation rules.

Returns:

the XSD translator

initializeFinished

public void initializeFinished()

Will be called when configuration of this object is finished.

setFileTranslationEnabled

public void setFileTranslationEnabled(String value)

Enables or disables the file translation rules.

Parameters:

value - if "true", file translation is enabled, otherwise it is disabled

setFolderTranslationEnabled

public void setFolderTranslationEnabled(String value)

Enables or disables the folder translation rules.

Parameters:

value - if "true", folder translation is enabled, otherwise it is disabled

setResourceManager

public void setResourceManager(CmsResourceManager manager)

Sets the generated resource manager.

Parameters:

manager - the resource manager to set

setXmlContentTypeManager

public void setXmlContentTypeManager(CmsXmlContentTypeManager manager)

Sets the generated XML content type manager.

Parameters:

manager - the generated XML content type manager to set

setXsdTranslationEnabled

public void setXsdTranslationEnabled(String value)

Enables or disables the XSD translation rules.

Parameters:

value - if "true", XSD translation is enabled, otherwise it is disabled

initMembers

protected void initMembers()

Description copied from class: A_CmsXmlConfiguration

Initializes member variables.

Specified by:

initMembers in class A_CmsXmlConfiguration

See Also:

• A_CmsXmlConfiguration.initMembers()