Class: ConfigurationManager

Requires

• module:mmir.require

Members

private_confConfigurationManagerModuleConfig

private_initializedPromise

Initialize promise that will be resolve after initialization is completed (set in init).

privateconfigDataObject

the configuration data (i.e. properties)

privateinstanceObject

Object containing the instance of the class mmir.ConfigurationManager.

privatelistenersmmir.tools.EventEmitter

EventEmitter for change-listeners that will be notified on changes on specific configurtion paths (dot-speparated property path)

privateloggermmir.tools.Logger

Methods

private_emitChange(newValue, oldValue, path)

manager/settings/configurationManager.js, line 90

HELPER for emitting on-change events to listeners

Name	Type	Description
newValue	any	the new configuration value
oldValue	any	the old configuration value
path	Array.<string>	the configuration path, i.e. list of segements of dot-separated path

private_get(propertyName, defaultValue, setAsDefaultIfUnset){any}

manager/settings/configurationManager.js, line 377

Returns the value of a property.

Name	Type	Description
propertyName	String | Array.<String>	if String: The name of the property. NOTE: If the property does not exists at the root-level, dot-separated names will be resolved into object-structures, e.g. some.property will be resolved so that the value at: some: {property: <value>} will be returned if String array: each entry corresponds to component in a dot-separated path (see above)
defaultValue	any	optional OPTIONAL a default value that will be returned, in case there is no property propertyName.
setAsDefaultIfUnset	Boolean	optional OPTIONAL if true, and there is no value set yet for propertyName, then the specified defaultValue will be set for propertyName. DEFAULT: false NOTE: if this argument is used, param defaultValue must also be given!

Returns:

Type	Description
any	The value of the property

private_getAsPath(propertyName){Array.<String>}

manager/settings/configurationManager.js, line 267

"Normalizes" a (dot-separated) string or an array into a path: the result is an array of path components (i.e. each path component is a separate entry). NOTE: if propertyName is an Array, its entries are used as-is, i.e. are NOT processed for string-entries that have dot-separating content:

      _getAsPath(['dot', 'separated.list']);//-> returns: ['dot', 'separated.list']
      

Name	Type	Description
propertyName	String | Array.<String>	resolves a dot-separated property-name into an array. If propertyName is an Array, all contained String entries will be resolved, if necessary

Returns:

Type	Description
Array.<String>	list of dot-separated components (without the dots)

Example

//result is ['dot', 'separated', 'list']
  _getAsPath('dot.separated.list');
  _getAsPath(['dot', 'separated', 'list']);

private_loadConfigFile(callback)

manager/settings/configurationManager.js, line 208

Helper that loads configuration file synchronously. Side-Effect: sets configData with loaded configuration data (if successful)

Name	Type	Description
callback	function	optional callback that is invoke after configuration was loaded callback(configData | null) If loading failed, callback will be invoked with null.

private_offChange(propertyName, listener){boolean}

manager/settings/configurationManager.js, line 182

Remove listener for configuration changes: if listener was registered multiple times, the first one is removed.

Name	Type	Description
propertyName	String | Array.<String>	optional OPTIONAL The name of the property, to listen for changes: if unspecified, listener will be removed from list of listeners for all configuration changes, otherwise it will be removed from listeners for the specified property-path.
listener	function	the listener function that will be invoked when a configuration value is changed: listener(newValue: any, oldValue: any, propertyName: string)

Returns:

Type	Description
boolean	true if a listener was removed, otherwise false.

private_onChange(propertyName, listener, emitOnAdding)

manager/settings/configurationManager.js, line 143

Register listener for configuration changes.

Name	Type	Description
propertyName	String | Array.<String>	optional OPTIONAL The name of the property, to listen for changes: if unspecified, listener will be invoked on all configuration changes. If propertyName is an Array, it will be treated as if its entries were path-elements analogous to a dot-separated String propertyName. NOTE: dot-separated names will be resolved into object-structures, e.g. some.property will be resolved so that the value will set to: some: {property: <value>}
listener	function	the listener function that will be invoked when a configuration value is changed: listener(newValue: any, oldValue: any, propertyName: string[]) where propertyName is the list of property-name path components (the last component is the property name itself) NOTE: if parameter propertyName was not specified, the third argument for the listener will be invoked with an empty Array.
emitOnAdding	Boolean	optional OPTIONAL if true the listener will be immediately be invoked after adding it with the current value listener(newValue: , oldValue: undefined, propertyName: ) NOTE: can only be used when param propertyName is specified.

private_set(propertyName, value){any}

manager/settings/configurationManager.js, line 438

Sets a property to a given value.

Name	Type	Description
propertyName	String | Array.<String>	The name of the property. If propertyName is an Array, it will be treated as if its entries were path-elements analogous to a dot-separated String propertyName. NOTE: dot-separated names will be resolved into object-structures, e.g. some.property will be resolved so that the value will set to: some: {property: <value>}
value	any	The value of the property

Throws:

if the propertyName is dot-separated AND one of its path-elements (except for the last) already exists AND its type is not 'object'

Type

Error

Returns:

Type	Description
any	The newly set value for the property

addListener(propertyName, listener, emitOnAdding)

manager/settings/configurationManager.js, line 660

Register listener for configuration changes.

Name	Type	Description
propertyName	String | Array.<String>	optional OPTIONAL The name of the property, to listen for changes: if unspecified, listener will be invoked on all configuration changes. If propertyName is an Array, it will be treated as if its entries were path-elements analogous to a dot-separated String propertyName. NOTE: dot-separated names will be resolved into object-structures, e.g. some.property will be resolved so that the value will set to: some: {property: <value>}
listener	function	the listener function that will be invoked when a configuration value is changed: listener(newValue: any, oldValue: any, propertyName: string[]) where propertyName is the list of property-name path components (the last component is the property name itself) NOTE: if parameter propertyName was not specified, the third argument for the listener will be invoked with an empty Array.
emitOnAdding	Boolean	optional OPTIONAL if true the listener will be immediately be invoked after adding it with the current value listener(newValue: , oldValue: undefined, propertyName: ) NOTE: can only be used when param propertyName is specified.

See:

• on

privateconstructor()

manager/settings/configurationManager.js, line 56

Constructor-Method of Singleton mmir.ConfigurationManager.

get(propertyName, defaultValue, setAsDefaultIfUnset){any}

manager/settings/configurationManager.js, line 530

Returns the value of a property.

Name	Type	Description
propertyName	String | Array.<String>	if String: The name of the property. NOTE: If the property does not exists at the root-level, dot-separated names will be resolved into object-structures, e.g. some.property will be resolved so that the value at: some: {property: <value>} will be returned if String array: each entry corresponds to component in a dot-separated path (see above)
defaultValue	any	optional OPTIONAL a default value that will be returned, in case there is no property propertyName.
setAsDefaultIfUnset	Boolean	optional OPTIONAL if true, and there is no value set yet for propertyName, then the specified defaultValue will be set for propertyName. DEFAULT: false NOTE: if this argument is used, param defaultValue must also be given!

See:

• set

Returns:

Type	Description
any	The value of the property

getBoolean(defaultValue)

manager/settings/configurationManager.js, line 563

Uses get. If the propertyName does not exists, returns undefined, otherwise values will be converted into Boolean values. Special case for Strings: the String "false" will be converted to Boolean value false.

Name	Type	Description
defaultValue	any	optional OPTIONAL if a default value is specified and there exists no property propertyName, the specified default value will be returned. NOTE: the default value will also be converted to a Boolean value, if necessary.

See:

• get

getNumber(defaultValue)

manager/settings/configurationManager.js, line 637

Uses get. If the property does not exists, returns undefined, otherwise values will be converted into Number values. If the value has not the type "string", it will be converted by JSON.stringify.

Name	Type	Description
defaultValue	any	optional OPTIONAL if a default value is specified and there exists no property propertyName, the specified default value will be returned. NOTE: the default value will also be converted to a Number value, if necessary.

See:

• get

getString(defaultValue)

manager/settings/configurationManager.js, line 600

Uses get. If the property does not exists, returns undefined, otherwise values will be converted into String values. If the value has not the type "string", it will be converted by JSON.stringify.

Name	Type	Description
defaultValue	any	optional OPTIONAL if a default value is specified and there exists no property propertyName, the specified default value will be returned. NOTE: the default value will also be converted to a String value, if necessary.

See:

• get

asyncinit(forceReloadConfig){Promise}

manager/settings/configurationManager.js, line 510

Initialize the configuration manager (i.e. loading configuration data etc.)

Name	Type	Description
forceReloadConfig	Boolean	optional OPTIONAL if FALSY, configuration data will only be loaded, if it has not been loaded yet. If TRUTHY, configuration data will be reloaded regardless, wether it is already available or not.

Returns:

Type	Description
Promise	a deferred promise that gets fulfilled when initialization is completed.

off(propertyName, listener){boolean}

manager/settings/configurationManager.js, line 685

Remove listener for configuration changes: if listener was registered multiple times, the first one is removed.

Name	Type	Description
propertyName	String | Array.<String>	optional OPTIONAL The name of the property, to listen for changes: if unspecified, listener will be removed from list of listeners for all configuration changes, otherwise it will be removed from listeners for the specified property-path.
listener	function	the listener function that will be invoked when a configuration value is changed: listener(newValue: any, oldValue: any, propertyName: string)

See:

• removeListener

Returns:

Type	Description
boolean	true if a listener was removed, otherwise false.

on(propertyName, listener, emitOnAdding)

manager/settings/configurationManager.js, line 677

Register listener for configuration changes.

Name	Type	Description
propertyName	String | Array.<String>	optional OPTIONAL The name of the property, to listen for changes: if unspecified, listener will be invoked on all configuration changes. If propertyName is an Array, it will be treated as if its entries were path-elements analogous to a dot-separated String propertyName. NOTE: dot-separated names will be resolved into object-structures, e.g. some.property will be resolved so that the value will set to: some: {property: <value>}
listener	function	the listener function that will be invoked when a configuration value is changed: listener(newValue: any, oldValue: any, propertyName: string[]) where propertyName is the list of property-name path components (the last component is the property name itself) NOTE: if parameter propertyName was not specified, the third argument for the listener will be invoked with an empty Array.
emitOnAdding	Boolean	optional OPTIONAL if true the listener will be immediately be invoked after adding it with the current value listener(newValue: , oldValue: undefined, propertyName: ) NOTE: can only be used when param propertyName is specified.

See:

• addListener

removeListener(propertyName, listener){boolean}

manager/settings/configurationManager.js, line 668

Remove listener for configuration changes: if listener was registered multiple times, the first one is removed.

Name	Type	Description
propertyName	String | Array.<String>	optional OPTIONAL The name of the property, to listen for changes: if unspecified, listener will be removed from list of listeners for all configuration changes, otherwise it will be removed from listeners for the specified property-path.
listener	function	the listener function that will be invoked when a configuration value is changed: listener(newValue: any, oldValue: any, propertyName: string)

See:

• off

Returns:

Type	Description
boolean	true if a listener was removed, otherwise false.

set(propertyName, value){any}

manager/settings/configurationManager.js, line 538

Sets a property to a given value.

Name	Type	Description
propertyName	String | Array.<String>	The name of the property. If propertyName is an Array, it will be treated as if its entries were path-elements analogous to a dot-separated String propertyName. NOTE: dot-separated names will be resolved into object-structures, e.g. some.property will be resolved so that the value will set to: some: {property: <value>}
value	any	The value of the property

See:

• get

Throws:

if the propertyName is dot-separated AND one of its path-elements (except for the last) already exists AND its type is not 'object'

Type

Error

Returns:

Type	Description
any	The newly set value for the property

toPath()

manager/settings/configurationManager.js, line 694

See:

• get