Package org.opencms.configuration

Class CmsParameterStore

java.lang.Object

org.opencms.configuration.CmsParameterStore

public class CmsParameterStore
extends Object

Class for accessing global 'weighted' configuration parameters defined in parameter files in the VFS. Used as a singleton.

Parameter files are XML configuration files that contain a list of named, string-valued configuration parameters, optionally with a numeric weight. The weight can be set individually for each parameter, or globally for a whole parameter file, but individual weights override parameter file weights. The schema for these is defined in org/opencm/configuration/paramfile.dtd.

To register a parameter file in OpenCms, its path must be listed as a value of the 'paramfile' module parameter for an installed module. The module parameter can be set on multiple modules, and may also contain multiple paths separated by commas.

When retrieving a value that is defined in multiple parameter files, the one with the highest weight wins. If there are multiple instances with the same weight, which one of them wins is implementation dependent.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CmsParameterStore.WeightedValue	An individual weighted parameter value, with a 'source' attribute for better debuggability.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	A_NAME	XML attribute name.
static final String	A_WEIGHT	XML attribute name.
static final double	DEFAULT_WEIGHT	Default weight, if not defined in parameter file.
static final String	N_PARAM	XML node name.
static final String	PARAM_PARAMFILE	Module parameter for registering parameter files.

Constructor Summary

Constructors

Constructor	Description
CmsParameterStore()

Method Summary

Modifier and Type	Method	Description
static CmsParameterStore	getInstance()	Gets the global instance.
String	getValue(CmsObject cms, String key)	Gets the string value with the maximal weight for the parameter with the given key.
CmsParameterStore.WeightedValue	getWeightedValue(CmsObject cms, String key)	Finds the value with the maximal weight for the given key.
static Map<String,CmsParameterStore.WeightedValue>	parse(byte[] data, String source)	Helper method for parsing a parameter file from a byte array.
static Map<String,CmsParameterStore.WeightedValue>	parse(org.dom4j.Element rootElem, String source)	Parses a parameter file from an XML element.
static Map<String,CmsParameterStore.WeightedValue>	parse(CmsObject cms, String path)	Helper method for parsing a parameter file from a VFS resource.

Methods inherited from class java.lang.Object

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

Field Details

A_NAME

public static final String A_NAME

XML attribute name.

See Also:

• Constant Field Values

A_WEIGHT

public static final String A_WEIGHT

XML attribute name.

See Also:

• Constant Field Values

DEFAULT_WEIGHT

public static final double DEFAULT_WEIGHT

Default weight, if not defined in parameter file.

See Also:

• Constant Field Values

N_PARAM

public static final String N_PARAM

XML node name.

See Also:

• Constant Field Values

PARAM_PARAMFILE

public static final String PARAM_PARAMFILE

Module parameter for registering parameter files.

See Also:

• Constant Field Values

Constructor Details

CmsParameterStore

public CmsParameterStore()

Method Details

getInstance

public static CmsParameterStore getInstance()

Gets the global instance.

Returns:

the global instance

parse

public static Map<String,CmsParameterStore.WeightedValue> parse(byte[] data,
 String source)
                                                         throws CmsXmlException

Helper method for parsing a parameter file from a byte array.

Parameters:

data - the binary data for the parameter file

source - the source identifier

Returns:

the of parameters

Throws:

CmsXmlException - if something goes wrong

parse

public static Map<String,CmsParameterStore.WeightedValue> parse(CmsObject cms,
 String path)
                                                         throws CmsException

Helper method for parsing a parameter file from a VFS resource.

Parameters:

cms - the CmsObject

path - the path of the resource

Returns:

the map of parameters

Throws:

CmsException - if something goes wrong

parse

public static Map<String,CmsParameterStore.WeightedValue> parse(org.dom4j.Element rootElem,
 String source)

Parses a parameter file from an XML element.

Parameters:

rootElem - the root element of the XML

source - the source identifier

Returns:

the parameter map

getValue

public String getValue(CmsObject cms,
 String key)

Gets the string value with the maximal weight for the parameter with the given key.

Parameters:

cms - the CMS context

key - the key

Returns:

the string value with maximal weight

getWeightedValue

public CmsParameterStore.WeightedValue getWeightedValue(CmsObject cms,
 String key)

Finds the value with the maximal weight for the given key.

Parameters:

cms - the CMS context

key - the parameter key

Returns:

the value with the maximal weight