Package org.opencms.ade.configuration

Class CmsConfigurationReader

java.lang.Object

org.opencms.ade.configuration.CmsConfigurationReader

public class CmsConfigurationReader
extends Object

A class to parse ADE sitemap or module configuration files and create configuration objects from them.

Field Summary

Fields

Modifier and Type	Field	Description
static final Locale	DEFAULT_LOCALE	The default locale for configuration objects.
static final String	N_ADD_CONTENT_RESTRICTION	The AddContentReplacements node name.
static final String	N_ADD_FORMATTER	Node name for added formatters.
static final String	N_ADD_FORMATTERS	Node name for the nested content with the added formatters.
static final String	N_ADD_PLUGIN	The AddPlugin node name.
static final String	N_ADD_PLUGINS	The AddPlugins node name.
static final String	N_ATTRIBUTE	The Attribute node name.
static final String	N_ATTRIBUTE_EDITOR_CONFIG	Node name for the attribute editor configuration reference.
static final String	N_CHECK_REUSE	Node name for the 'Check reuse' option.
static final String	N_COPY_IN_MODELS	The CopyInModels node name.
static final String	N_CREATE_CONTENTS_LOCALLY	The create content locally node name.
static final String	N_DEFAULT	The default node name.
static final String	N_DESCRIPTION	The description node name.
static final String	N_DETAIL_PAGE	The detail page node name.
static final String	N_DETAIL_PAGES_DISABLED	The detail pages disabled node name.
static final String	N_DISABLED	The disabled node name.
static final String	N_DISABLED_FUNCTIONS_MODE	The DisabledFunctionsMode node name.
static final String	N_DISABLED_TYPES_MODE	The DisabledTypesMode node name.
static final String	N_DISCARD_MODEL_PAGES	The discard model pages node name.
static final String	N_DISCARD_PROPERTIES	The discard properties node name.
static final String	N_DISCARD_TYPES	The discard types node name.
static final String	N_DISPLAY_NAME	The display name node name.
static final String	N_ELEMENT_VIEW	The element view node name.
static final String	N_ERROR	The error node name.
static final String	N_EXCLUDE_EXTERNAL_DETAIL_CONTENTS	The 'exclude external detail contents' node name.
static final String	N_FOLDER	The folder node name.
static final String	N_FORMATTER	The formatter node name.
static final String	N_FUNCTION	The function node name.
static final String	N_FUNCTION_DEFAULT_PAGE	The function node name.
static final String	N_FUNCTION_REF	The function reference node name.
static final String	N_INCLUDE_IN_SITE_SELECTOR	The 'include in site selector' node name.
static final String	N_INCLUDE_NAME	The IncludeName node name.
static final String	N_IS_DEFAULT	The is default node name.
static final String	N_IS_PREVIEW	The is preview node name.
static final String	N_JSP	The JSP node name.
static final String	N_KEY	The Key node name.
static final String	N_LOCALIZATION	The localization node name.
static final String	N_MASTER_CONFIG	The master configuration node name.
static final String	N_MAX_WIDTH	The max width node name.
static final String	N_MIN_WIDTH	The min width node name.
static final String	N_MODEL_PAGE	The model page node name.
static final String	N_NAME	The folder name node name.
static final String	N_NAME_PATTERN	The name pattern node name.
static final String	N_ORDER	The order node name.
static final String	N_PAGE	The page node name.
static final String	N_PAGE_RELATIVE	The PageRelative node name.
static final String	N_PATH	The folder path node name.
static final String	N_PLUGIN	The Plugin node name.
static final String	N_PREFER_DETAIL_PAGES_FOR_LOCAL_CONTENTS	The PreferDetailPagesForLocalContents node name.
static final String	N_PREFER_FOLDER	The prefer folder node name.
static final String	N_PROPERTY	The property node name.
static final String	N_PROPERTY_NAME	The property name node name.
static final String	N_PROPERTY_NAME_ALIAS	XML node name.
static final String	N_REMOVE_ALL_FORMATTERS	Node name for the "Remove all formatters"-option.
static final String	N_REMOVE_ALL_FUNCTIONS	Field name for the 'Remove all functions' setting.
static final String	N_REMOVE_ALL_PLUGINS	The RemoveAllPlugins node name.
static final String	N_REMOVE_ALL_SHARED_SETTING_OVERRIDES	The RemoveAllSharedSettingOverrides node name.
static final String	N_REMOVE_FORMATTER	Node name for removed formatters.
static final String	N_REMOVE_FORMATTERS	Node name for the nested content with the removed formatters.
static final String	N_REMOVE_FUNCTIONS	The remove function node name.
static final String	N_REMOVE_PLUGIN	The RemovePlugin node name.
static final String	N_REMOVE_PLUGINS	The RemovePlugins node name.
static final String	N_RESOURCE_TYPE	The resource type node name.
static final String	N_RULE_REGEX	The regex rule node name.
static final String	N_RULE_TYPE	The rule type node name.
static final String	N_SHARED_SETTING_OVERRIDE	The SharedSettingOverride node name.
static final String	N_SHOW_IN_DEFAULT_VIEW	The ShowInDefaultView node name.
static final String	N_TYPE	The type node name.
static final String	N_TYPE_NAME	The type name node name.
static final String	N_TYPE_ORDERING_MODE	The node name for the type ordering mode.
static final String	N_USE_FORMATTER_KEYS	Node name.
static final String	N_VALUE	The Value node name.
static final String	N_VALUE_TRANSLATION	XML node name.
static final String	N_VISIBILITY	The widget node name.
static final String	N_WIDGET	The widget node name.
static final String	N_WIDGET_CONFIG	The widget configuration node name.
static final String	VIEW_SCHEME	Scheme for explorer type view links.

Constructor Summary

Constructors

Constructor	Description
CmsConfigurationReader(CmsObject cms)	Creates a new configuration reader.

Method Summary

Modifier and Type	Method	Description
protected boolean	getBoolean(I_CmsXmlContentLocation parent, String name)	Helper method to read a boolean value from the XML.
List<CmsFunctionReference>	getFunctionReferences()	Returns the list of function references.
List<CmsModelPageConfigWithoutResource>	getModelPageConfigs()	Returns the modelPageConfigs.
static String	getString(CmsObject cms, I_CmsXmlContentValueLocation location)	Gets the string value of an XML content location.
protected String	getString(I_CmsXmlContentValueLocation location)	Gets the string value of an XML content location.
Set<String>	parseAddFormatters(I_CmsXmlContentLocation node)	Parses the formatters to add.
CmsADEConfigDataInternal	parseConfiguration(String basePath, CmsXmlContent content)	Parses a configuration XML content and creates a configuration object from it.
protected void	parseDetailPage(I_CmsXmlContentLocation node)	Parses the detail pages from an XML content node.
CmsContentFolderDescriptor	parseFolderOrName(String basePath, I_CmsXmlContentLocation location)	Parses a folder which may either be given as a path or as a folder name.
CmsFormatterBean	parseFormatter(String typeName, I_CmsXmlContentLocation node)	Parses a formatter bean.
protected CmsFormatterChangeSet	parseFormatterChangeSet(String basePath, I_CmsXmlContentLocation node, boolean removeAllFormatters, boolean removeFunctions, Set<CmsUUID> functions, Set<CmsUUID> functionsToRemove)	Parses the formatter change set.
protected void	parseFunctionReference(I_CmsXmlContentLocation node)	Parses a function reference node.
void	parseModelPage(I_CmsXmlContentLocation node)	Parses model page data from the XML content.
static CmsPropertyConfig	parseProperty(CmsObject cms, I_CmsXmlContentLocation field)	Helper method to parse a property.
Set<String>	parseRemoveFormatters(I_CmsXmlContentLocation node)	Parses the set of formatters to remove.
void	parseResourceTypeConfig(String basePath, I_CmsXmlContentLocation node)	Parses a resource type configuration element from the XML content.
CmsADEConfigDataInternal	parseSitemapConfiguration(String basePath, CmsResource configRes)	Parses the sitemap configuration given the configuration file and base path.
List<CmsADEConfigDataInternal>	readModuleConfigurations()	Reads the configurations of all modules and combines them into a single configuration object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_LOCALE

public static final Locale DEFAULT_LOCALE

The default locale for configuration objects.

N_ADD_CONTENT_RESTRICTION

public static final String N_ADD_CONTENT_RESTRICTION

The AddContentReplacements node name.

See Also:

• Constant Field Values

N_ADD_FORMATTER

public static final String N_ADD_FORMATTER

Node name for added formatters.

See Also:

• Constant Field Values

N_ADD_FORMATTERS

public static final String N_ADD_FORMATTERS

Node name for the nested content with the added formatters.

See Also:

• Constant Field Values

N_ADD_PLUGIN

public static final String N_ADD_PLUGIN

The AddPlugin node name.

See Also:

• Constant Field Values

N_ADD_PLUGINS

public static final String N_ADD_PLUGINS

The AddPlugins node name.

See Also:

• Constant Field Values

N_ATTRIBUTE

public static final String N_ATTRIBUTE

The Attribute node name.

See Also:

• Constant Field Values

N_ATTRIBUTE_EDITOR_CONFIG

public static final String N_ATTRIBUTE_EDITOR_CONFIG

Node name for the attribute editor configuration reference.

See Also:

• Constant Field Values

N_CHECK_REUSE

public static final String N_CHECK_REUSE

Node name for the 'Check reuse' option.

See Also:

• Constant Field Values

N_COPY_IN_MODELS

public static final String N_COPY_IN_MODELS

The CopyInModels node name.

See Also:

• Constant Field Values

N_CREATE_CONTENTS_LOCALLY

public static final String N_CREATE_CONTENTS_LOCALLY

The create content locally node name.

See Also:

• Constant Field Values

N_DEFAULT

public static final String N_DEFAULT

The default node name.

See Also:

• Constant Field Values

N_DESCRIPTION

public static final String N_DESCRIPTION

The description node name.

See Also:

• Constant Field Values

N_DETAIL_PAGE

public static final String N_DETAIL_PAGE

The detail page node name.

See Also:

• Constant Field Values

N_DETAIL_PAGES_DISABLED

public static final String N_DETAIL_PAGES_DISABLED

The detail pages disabled node name.

See Also:

• Constant Field Values

N_DISABLED

public static final String N_DISABLED

The disabled node name.

See Also:

• Constant Field Values

N_DISABLED_FUNCTIONS_MODE

public static final String N_DISABLED_FUNCTIONS_MODE

The DisabledFunctionsMode node name.

See Also:

• Constant Field Values

N_DISABLED_TYPES_MODE

public static final String N_DISABLED_TYPES_MODE

The DisabledTypesMode node name.

See Also:

• Constant Field Values

N_DISCARD_MODEL_PAGES

public static final String N_DISCARD_MODEL_PAGES

The discard model pages node name.

See Also:

• Constant Field Values

N_DISCARD_PROPERTIES

public static final String N_DISCARD_PROPERTIES

The discard properties node name.

See Also:

• Constant Field Values

N_DISCARD_TYPES

public static final String N_DISCARD_TYPES

The discard types node name.

See Also:

• Constant Field Values

N_DISPLAY_NAME

public static final String N_DISPLAY_NAME

The display name node name.

See Also:

• Constant Field Values

N_ELEMENT_VIEW

public static final String N_ELEMENT_VIEW

The element view node name.

See Also:

• Constant Field Values

N_ERROR

public static final String N_ERROR

The error node name.

See Also:

• Constant Field Values

N_EXCLUDE_EXTERNAL_DETAIL_CONTENTS

public static final String N_EXCLUDE_EXTERNAL_DETAIL_CONTENTS

The 'exclude external detail contents' node name.

See Also:

• Constant Field Values

N_FOLDER

public static final String N_FOLDER

The folder node name.

See Also:

• Constant Field Values

N_FORMATTER

public static final String N_FORMATTER

The formatter node name.

See Also:

• Constant Field Values

N_FUNCTION

public static final String N_FUNCTION

The function node name.

See Also:

• Constant Field Values

N_FUNCTION_DEFAULT_PAGE

public static final String N_FUNCTION_DEFAULT_PAGE

The function node name.

See Also:

• Constant Field Values

N_FUNCTION_REF

public static final String N_FUNCTION_REF

The function reference node name.

See Also:

• Constant Field Values

N_INCLUDE_IN_SITE_SELECTOR

public static final String N_INCLUDE_IN_SITE_SELECTOR

The 'include in site selector' node name.

See Also:

• Constant Field Values

N_INCLUDE_NAME

public static final String N_INCLUDE_NAME

The IncludeName node name.

See Also:

• Constant Field Values

N_IS_DEFAULT

public static final String N_IS_DEFAULT

The is default node name.

See Also:

• Constant Field Values

N_IS_PREVIEW

public static final String N_IS_PREVIEW

The is preview node name.

See Also:

• Constant Field Values

N_JSP

public static final String N_JSP

The JSP node name.

See Also:

• Constant Field Values

N_KEY

public static final String N_KEY

The Key node name.

See Also:

• Constant Field Values

N_LOCALIZATION

public static final String N_LOCALIZATION

The localization node name.

See Also:

• Constant Field Values

N_MASTER_CONFIG

public static final String N_MASTER_CONFIG

The master configuration node name.

See Also:

• Constant Field Values

N_MAX_WIDTH

public static final String N_MAX_WIDTH

The max width node name.

See Also:

• Constant Field Values

N_MIN_WIDTH

public static final String N_MIN_WIDTH

The min width node name.

See Also:

• Constant Field Values

N_MODEL_PAGE

public static final String N_MODEL_PAGE

The model page node name.

See Also:

• Constant Field Values

N_NAME

public static final String N_NAME

The folder name node name.

See Also:

• Constant Field Values

N_NAME_PATTERN

public static final String N_NAME_PATTERN

The name pattern node name.

See Also:

• Constant Field Values

N_ORDER

public static final String N_ORDER

The order node name.

See Also:

• Constant Field Values

N_PAGE

public static final String N_PAGE

The page node name.

See Also:

• Constant Field Values

N_PAGE_RELATIVE

public static final String N_PAGE_RELATIVE

The PageRelative node name.

See Also:

• Constant Field Values

N_PATH

public static final String N_PATH

The folder path node name.

See Also:

• Constant Field Values

N_PLUGIN

public static final String N_PLUGIN

The Plugin node name.

See Also:

• Constant Field Values

N_PREFER_DETAIL_PAGES_FOR_LOCAL_CONTENTS

public static final String N_PREFER_DETAIL_PAGES_FOR_LOCAL_CONTENTS

The PreferDetailPagesForLocalContents node name.

See Also:

• Constant Field Values

N_PREFER_FOLDER

public static final String N_PREFER_FOLDER

The prefer folder node name.

See Also:

• Constant Field Values

N_PROPERTY

public static final String N_PROPERTY

The property node name.

See Also:

• Constant Field Values

N_PROPERTY_NAME

public static final String N_PROPERTY_NAME

The property name node name.

See Also:

• Constant Field Values

N_PROPERTY_NAME_ALIAS

public static final String N_PROPERTY_NAME_ALIAS

XML node name.

See Also:

• Constant Field Values

N_REMOVE_ALL_FORMATTERS

public static final String N_REMOVE_ALL_FORMATTERS

Node name for the "Remove all formatters"-option.

See Also:

• Constant Field Values

N_REMOVE_ALL_FUNCTIONS

public static final String N_REMOVE_ALL_FUNCTIONS

Field name for the 'Remove all functions' setting.

See Also:

• Constant Field Values

N_REMOVE_ALL_PLUGINS

public static final String N_REMOVE_ALL_PLUGINS

The RemoveAllPlugins node name.

See Also:

• Constant Field Values

N_REMOVE_ALL_SHARED_SETTING_OVERRIDES

public static final String N_REMOVE_ALL_SHARED_SETTING_OVERRIDES

The RemoveAllSharedSettingOverrides node name.

See Also:

• Constant Field Values

N_REMOVE_FORMATTER

public static final String N_REMOVE_FORMATTER

Node name for removed formatters.

See Also:

• Constant Field Values

N_REMOVE_FORMATTERS

public static final String N_REMOVE_FORMATTERS

Node name for the nested content with the removed formatters.

See Also:

• Constant Field Values

N_REMOVE_FUNCTIONS

public static final String N_REMOVE_FUNCTIONS

The remove function node name.

See Also:

• Constant Field Values

N_REMOVE_PLUGIN

public static final String N_REMOVE_PLUGIN

The RemovePlugin node name.

See Also:

• Constant Field Values

N_REMOVE_PLUGINS

public static final String N_REMOVE_PLUGINS

The RemovePlugins node name.

See Also:

• Constant Field Values

N_RESOURCE_TYPE

public static final String N_RESOURCE_TYPE

The resource type node name.

See Also:

• Constant Field Values

N_RULE_REGEX

public static final String N_RULE_REGEX

The regex rule node name.

See Also:

• Constant Field Values

N_RULE_TYPE

public static final String N_RULE_TYPE

The rule type node name.

See Also:

• Constant Field Values

N_SHARED_SETTING_OVERRIDE

public static final String N_SHARED_SETTING_OVERRIDE

The SharedSettingOverride node name.

See Also:

• Constant Field Values

N_SHOW_IN_DEFAULT_VIEW

public static final String N_SHOW_IN_DEFAULT_VIEW

The ShowInDefaultView node name.

See Also:

• Constant Field Values

N_TYPE

public static final String N_TYPE

The type node name.

See Also:

• Constant Field Values

N_TYPE_NAME

public static final String N_TYPE_NAME

The type name node name.

See Also:

• Constant Field Values

N_TYPE_ORDERING_MODE

public static final String N_TYPE_ORDERING_MODE

The node name for the type ordering mode.

See Also:

• Constant Field Values

N_USE_FORMATTER_KEYS

public static final String N_USE_FORMATTER_KEYS

Node name.

See Also:

• Constant Field Values

N_VALUE

public static final String N_VALUE

The Value node name.

See Also:

• Constant Field Values

N_VALUE_TRANSLATION

public static final String N_VALUE_TRANSLATION

XML node name.

See Also:

• Constant Field Values

N_VISIBILITY

public static final String N_VISIBILITY

The widget 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_CONFIG

public static final String N_WIDGET_CONFIG

The widget configuration node name.

See Also:

• Constant Field Values

VIEW_SCHEME

public static final String VIEW_SCHEME

Scheme for explorer type view links.

See Also:

• Constant Field Values

Constructor Details

CmsConfigurationReader

public CmsConfigurationReader(CmsObject cms)

Creates a new configuration reader.

Parameters:

cms - the CMS context which should be used to read the configuration data.

Method Details

getString

public static String getString(CmsObject cms,
 I_CmsXmlContentValueLocation location)

Gets the string value of an XML content location.

Parameters:

cms - the CMS context to use

location - an XML content location

Returns:

the string value of that XML content location

parseProperty

public static CmsPropertyConfig parseProperty(CmsObject cms,
 I_CmsXmlContentLocation field)

Helper method to parse a property.

Parameters:

cms - the CMS context to use

field - the location of the parent value

Returns:

the parsed property configuration

getFunctionReferences

public List<CmsFunctionReference> getFunctionReferences()

Returns the list of function references.

Returns:

the list of function references

getModelPageConfigs

public List<CmsModelPageConfigWithoutResource> getModelPageConfigs()

Returns the modelPageConfigs.

Returns:

the modelPageConfigs

parseAddFormatters

public Set<String> parseAddFormatters(I_CmsXmlContentLocation node)

Parses the formatters to add.

Parameters:

node - the parent node

Returns:

the set of keys of the formatters to add

parseConfiguration

public CmsADEConfigDataInternal parseConfiguration(String basePath,
 CmsXmlContent content)
                                            throws CmsException

Parses a configuration XML content and creates a configuration object from it.

Parameters:

basePath - the base path

content - the XML content

Returns:

the created configuration object with the data from the XML content

Throws:

CmsException - if something goes wrong

parseFolderOrName

public CmsContentFolderDescriptor parseFolderOrName(String basePath,
 I_CmsXmlContentLocation location)
                                             throws CmsException

Parses a folder which may either be given as a path or as a folder name.

Parameters:

basePath - the base path for the configuration

location - the XML content node from which to parse the folder

Returns:

the folder bean

Throws:

CmsException - if something goes wrong

parseFormatter

public CmsFormatterBean parseFormatter(String typeName,
 I_CmsXmlContentLocation node)

Parses a formatter bean.

Parameters:

typeName - the type name for which the formatter is being parsed

node - the node from which to parse the formatter data

Returns:

the formatter bean from the XML

parseModelPage

public void parseModelPage(I_CmsXmlContentLocation node)

Parses model page data from the XML content.

Parameters:

node - the XML content node

parseRemoveFormatters

public Set<String> parseRemoveFormatters(I_CmsXmlContentLocation node)

Parses the set of formatters to remove.

Parameters:

node - the parent node

Returns:

the set of formatters to remove

parseResourceTypeConfig

public void parseResourceTypeConfig(String basePath,
 I_CmsXmlContentLocation node)
                             throws CmsException

Parses a resource type configuration element from the XML content.

Parameters:

basePath - the base path of the configuration

node - the XML configuration node

Throws:

CmsException - if something goes wrong

parseSitemapConfiguration

public CmsADEConfigDataInternal parseSitemapConfiguration(String basePath,
 CmsResource configRes)
                                                   throws CmsException

Parses the sitemap configuration given the configuration file and base path.

Parameters:

basePath - the base path

configRes - the configuration file resource

Returns:

the parsed configuration data

Throws:

CmsException - if something goes wrong

readModuleConfigurations

public List<CmsADEConfigDataInternal> readModuleConfigurations()

Reads the configurations of all modules and combines them into a single configuration object.

Returns:

the combined configuration object

getBoolean

protected boolean getBoolean(I_CmsXmlContentLocation parent,
 String name)

Helper method to read a boolean value from the XML.

If the element is not found in the XML, false is returned.

Parameters:

parent - the parent node

name - the name of the XML content value

Returns:

the boolean value

getString

protected String getString(I_CmsXmlContentValueLocation location)

Gets the string value of an XML content location.

Parameters:

location - an XML content location

Returns:

the string value of that XML content location

parseDetailPage

protected void parseDetailPage(I_CmsXmlContentLocation node)

Parses the detail pages from an XML content node.

Parameters:

node - the XML content node

parseFormatterChangeSet

protected CmsFormatterChangeSet parseFormatterChangeSet(String basePath,
 I_CmsXmlContentLocation node,
 boolean removeAllFormatters,
 boolean removeFunctions,
 Set<CmsUUID> functions,
 Set<CmsUUID> functionsToRemove)

Parses the formatter change set.

Parameters:

basePath - the configuration base path

node - the parent node

removeAllFormatters - flag, indicating if all formatters that are not explicitly added should be removed

removeFunctions - if true, remove functions

functions - the functions to add

functionsToRemove - the functions to remove

Returns:

the formatter change set

parseFunctionReference

protected void parseFunctionReference(I_CmsXmlContentLocation node)

Parses a function reference node.

Parameters:

node - the function reference node