Twyr Web Application Server

ServerAdministration

The Twyr Web Application Server ServerAdministration feature - manages server settings.

Constructor

new ServerAdministration()

Source:

server/features/server_administration/feature.js, line 15

Extends

TwyrBaseFeature

Members

(readonly) basePath :string

Source:

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

Overrides:

TwyrBaseFeature#basePath

Type:

string

(readonly) dependencies :Object

Source:

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

Inherited From:

TwyrBaseModule#dependencies

Type:

Object

(readonly) EmberAssets :Object

Source:

framework/twyr-base-feature.js, line 340

Inherited From:

TwyrBaseFeature#EmberAssets

Type:

Object

(readonly) name :string

Source:

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

Inherited From:

TwyrBaseClass#name

Type:

string

(readonly) Router :Object

Source:

framework/twyr-base-feature.js, line 329

Inherited From:

TwyrBaseFeature#Router

Type:

Object

Methods

(async) _abac(ctxt, next) → {undefined}

Derived classes should call next, or throw a {TwyrFeatureError} - depending on whether the user can access this particular resource.

Source:

framework/twyr-base-feature.js, line 260

Inherited From:

TwyrBaseFeature#_abac

Parameters:

Name	Type	Description
`ctxt`	Object	Koa context.
`next`	callback	Callback to pass the request on to the next route in the chain.

Returns:

Nothing.

Type: undefined

(async) _addRoutes() → {undefined}

Adds routes to the Koa Router.

Source:

framework/twyr-base-feature.js, line 278

Inherited From:

TwyrBaseFeature#_addRoutes

Returns:

Nothing.

Type: undefined

(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) _deleteRoutes() → {undefined}

Removes all the routes from the Koa Router.

Source:

framework/twyr-base-feature.js, line 307

Inherited From:

TwyrBaseFeature#_deleteRoutes

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

_rbac(permission) → {undefined}

Derived classes should call next, or throw a {TwyrFeatureError} - depending on whether the user has the required permission(s).

Source:

framework/twyr-base-feature.js, line 225

Inherited From:

TwyrBaseFeature#_rbac

Parameters:

Name	Type	Description
`permission`	string	The permission to check for.

Returns:

Koa middleware that can be injected into a route.

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-feature.js, line 102

Inherited From:

TwyrBaseFeature#_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) getClientsideAssets(ctxt, tenantFeatures) → {Object}

Returns the route map that is used by the Ember.js Router on the browser.

Source:

framework/twyr-base-feature.js, line 131

Inherited From:

TwyrBaseFeature#getClientsideAssets

Parameters:

Name	Type	Description
`ctxt`	Object	Koa context.
`tenantFeatures`	Object	Sub-features allowed for this Tenant.

Returns:

Containing the compiled Ember.js client-side assets (specifically the route map, but could be others, as well).

Type: Object

(async) getDashboardDisplayDetails(ctxt) → {Object}

Derived classes should return details, or null - depending on whether the user has the required permission(s).

Source:

framework/twyr-base-feature.js, line 189

Overrides:

TwyrBaseFeature#getDashboardDisplayDetails

Parameters:

Name	Type	Description
`ctxt`	Object	Koa context.

Returns:

Dashboard display stuff for this Feature.

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

Inherited From:

TwyrBaseModule#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) 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