Twyr Web Application Server

ConfigurationService

The Twyr Web Application Server Configuration Service.

Constructor

new ConfigurationService()

Serves as the "single source of truth" for configuration related operations across the rest of the codebase.

Source:

server/services/configuration_service/service.js, line 20

Serves as the "single source of truth" for configuration related operations across the rest of the codebase.

Extends

TwyrBaseService

Members

(readonly) basePath :string

Source:

framework/twyr-base-class.js, line 58

Overrides:

TwyrBaseService#basePath

Type:

string

(readonly) dependencies :Object

Source:

framework/twyr-base-module.js, line 562

Inherited From:

TwyrBaseModule#dependencies

Type:

Object

(readonly) Interface :Object

Source:

framework/twyr-base-service.js, line 39

Overrides:

TwyrBaseService#Interface

Type:

Object

(readonly) name :string

Source:

framework/twyr-base-class.js, line 47

Inherited From:

TwyrBaseClass#name

Type:

string

Methods

(async) _changeState(newState) → {undefined}

Enables / disables this module, and all its sub-modules (if any).

Source:

framework/twyr-base-module.js, line 401

Inherited From:

TwyrBaseModule#_changeState

Parameters:

Name	Type	Description
`newState`	Object	The next state of this module.

Returns:

Nothing.

Type: undefined

(async) _dependencyReconfigure(dependency) → {undefined}

Lets the module know that one of its dependencies changed configuration.

Source:

framework/twyr-base-module.js, line 381

Inherited From:

TwyrBaseModule#_dependencyReconfigure

Parameters:

Name	Type	Description
`dependency`	TwyrBaseModule	The dependency that changed configuration.

Returns:

Nothing.

Type: undefined

(async) _dependencyStateChange(dependency, newState) → {undefined}

Lets the module know that one of its dependencies changed state.

Source:

framework/twyr-base-module.js, line 491

Inherited From:

TwyrBaseModule#_dependencyStateChange

Parameters:

Name	Type	Description
`dependency`	TwyrBaseModule	The dependency that changed state.
`newState`	Object	The next state of the dependency.

Returns:

Nothing.

Type: undefined

(async) _exists(filepath, mode) → {boolean}

Checks to see if the path can be accessed by this process using the mode specified.

Source:

framework/twyr-base-module.js, line 522

Inherited From:

TwyrBaseModule#_exists

Parameters:

Name	Type	Description
`filepath`	string	Path of the filesystem entity.
`mode`	number	Permission to be checked for.

Returns:

True / False.

Type: boolean

_handleUncaughtException(err) → {undefined}

Logs Unhandled Exceptions to prevent the process from crashing.

Source:

framework/twyr-base-class.js, line 31

Inherited From:

TwyrBaseClass#_handleUncaughtException

Parameters:

Name	Type	Description
`err`	Error	The unhandled exception.

Returns:

Nothing.

Type: undefined

(async) _parentReconfigure() → {undefined}

Lets the module know that its parent changed configuration.

Source:

framework/twyr-base-module.js, line 365

Inherited From:

TwyrBaseModule#_parentReconfigure

Returns:

Nothing.

Type: undefined

(async) _parentStateChange(newState) → {undefined}

Lets the module know that its parent changed state.

Source:

framework/twyr-base-module.js, line 471

Inherited From:

TwyrBaseModule#_parentStateChange

Parameters:

Name	Type	Description
`newState`	Object	The next state of the parent module.

Returns:

Nothing.

Type: undefined

(async) _reconfigure(newConfig) → {undefined}

Changes the configuration of this module, and informs everyone interested.

Source:

framework/twyr-base-module.js, line 281

Inherited From:

TwyrBaseModule#_reconfigure

Parameters:

Name	Type	Description
`newConfig`	Object	The changed confoguration.

Returns:

Nothing.

Type: undefined

(async) _setup() → {undefined}

To be implemented by derived classes for setting themselves up.

Source:

framework/twyr-base-module.js, line 247

Inherited From:

TwyrBaseModule#_setup

Returns:

Nothing.

Type: undefined

(async) _subModuleReconfigure(subModule) → {undefined}

Lets the module know that one of its subModules changed configuration.

Source:

framework/twyr-base-module.js, line 347

Inherited From:

TwyrBaseModule#_subModuleReconfigure

Parameters:

Name	Type	Description
`subModule`	TwyrBaseModule	The sub-module that changed configuration.

Returns:

Nothing.

Type: undefined

(async) _subModuleStateChange(subModule, newState) → {undefined}

Lets the module know that one of its subModules changed state.

Source:

framework/twyr-base-module.js, line 452

Inherited From:

TwyrBaseModule#_subModuleStateChange

Parameters:

Name	Type	Description
`subModule`	TwyrBaseModule	The sub-module that changed state.
`newState`	Object	The next state of the sub-module.

Returns:

Nothing.

Type: undefined

(async) _teardown() → {undefined}

To be implemented by derived classes for un-setting themselves down.

Source:

framework/twyr-base-module.js, line 263

Inherited From:

TwyrBaseModule#_teardown

Returns:

Nothing.

Type: undefined

(async) getModuleId(twyrModule) → {Object}

Retrieves the id of the twyrModule requesting for it.

Source:

server/services/configuration_service/service.js, line 253

Parameters:

Name	Type	Description
`twyrModule`	TwyrBaseModule	Instance of the `TwyrBaseModule` that requires its id.

Returns:

The id of the twyrModule.

Type: Object

(async) getModuleState(twyrModule) → {Object}

Retrieves the state of the twyrModule requesting for it.

Source:

server/services/configuration_service/service.js, line 182

Parameters:

Name	Type	Description
`twyrModule`	TwyrBaseModule	Instance of the `TwyrBaseModule` that requires its state.

Returns:

The merged states returned by sub-modules.

Type: Object

(async) initialize() → {Object}

Initializes sub-modules, if any.

Source:

framework/twyr-base-module.js, line 101

Inherited From:

TwyrBaseModule#initialize

Call the loader (typically, TwyrModuleLoader#initialize) to initialize sub-modules, if any.

Returns:

The aggregated status returned by sub-modules (if any) once they complete their initialization.

Type: Object

(async) load(configSrvc) → {Object}

Loads sub-modules, if any.

Source:

framework/twyr-base-module.js, line 64

Overrides:

TwyrBaseService#load

Use the supplied ConfigurationService instance (if any), to get / store both configuration and state.
Call the loader (typically, TwyrModuleLoader#load) to load sub-modules, if any.

Parameters:

Name	Type	Description
`configSrvc`	ConfigurationService	Instance of the `ConfigurationService` that supplies configuration.

Returns:

The aggregated status returned by sub-modules (if any) once they complete their loading.

Type: Object

(async) loadConfiguration(twyrModule) → {Object}

Retrieves the configuration of the twyrModule requesting for it.

Source:

server/services/configuration_service/service.js, line 88

Parameters:

Name	Type	Description
`twyrModule`	TwyrBaseModule	Instance of the `TwyrBaseModule` that requires configuration.

Returns:

The merged configurations returned by sub-modules.

Type: Object

(async) saveConfiguration(twyrModule, config) → {Object}

Saves the configuration of the twyrModule requesting for it.

Source:

server/services/configuration_service/service.js, line 152

Parameters:

Name	Type	Description
`twyrModule`	TwyrBaseModule	Instance of the `TwyrBaseModule` that requires configuration.
`config`	Object	The `TwyrBaseModule`'s' configuration that should be persisted.

Returns:

The twyrModule configuration.

Type: Object

(async) setModuleState(twyrModule, enabled) → {Object}

Saves the state of the twyrModule requesting for it.

Source:

server/services/configuration_service/service.js, line 217

Parameters:

Name	Type	Description
`twyrModule`	TwyrBaseModule	Instance of the `TwyrBaseModule` that requires its state.
`enabled`	boolean	State of the module.

Returns:

The state of the twyrModule.

Type: Object

(async) start(dependencies) → {Object}

Starts sub-modules, if any.

Source:

framework/twyr-base-module.js, line 127

Inherited From:

TwyrBaseModule#start

Call the loader (typically, TwyrModuleLoader#start) to start sub-modules, if any.

Parameters:

Name	Type	Description
`dependencies`	Object	Interfaces to `TwyrBaseService` instances that this module depends on.

Returns:

The aggregated status returned by sub-modules (if any) once they complete their startup sequences.

Type: Object

(async) stop() → {Object}

Stops sub-modules, if any.

Source:

framework/twyr-base-module.js, line 167

Inherited From:

TwyrBaseModule#stop

Call the loader (typically, TwyrModuleLoader#stop) to shutdown sub-modules, if any.

Returns:

The aggregated status returned by sub-modules (if any) once they complete their shutdown sequences.

Type: Object

(async) uninitialize() → {Object}

Uninitializes sub-modules, if any.

Source:

framework/twyr-base-module.js, line 195

Inherited From:

TwyrBaseModule#uninitialize

Call the loader (typically, TwyrModuleLoader#uninitialize) to uninitialize sub-modules, if any.

Returns:

The aggregated status returned by sub-modules (if any) once they uninitialize themselves.

Type: Object

(async) unload() → {Object}

Unloads sub-modules, if any.

Source:

framework/twyr-base-module.js, line 221

Inherited From:

TwyrBaseModule#unload

Call the loader (typically, TwyrModuleLoader#unload) to unload sub-modules, if any.

Returns:

The aggregated status returned by sub-modules (if any) once they unload themselves.

Type: Object