Class: ALARMiatorPluginManager

ALARMiatorPluginManager()

Generic ALARMiator Plugin Manager Class author: Jens Dinstühler vesion: 1.0.0

Constructor

new ALARMiatorPluginManager()

Source:

Methods

event_new_admin_notification(notificationInfo)

A new notification to admin shall be sent
Parameters:
Name Type Description
notificationInfo object notification object
Source:

event_new_alarm(alarmInfo)

a new alarm took place
Parameters:
Name Type Description
alarmInfo object alarm object
Source:

event_new_feedback_received(operationUUID, basedataUUID, stateId)

a new feedback response has been received
Parameters:
Name Type Description
operationUUID string uuid of operation, this feedback belongs to
basedataUUID string uuid of basedata sending the new state
stateId integer id of feedback state from table
Source:

event_new_state(stateInfo)

a new state has been sent
Parameters:
Name Type Description
stateInfo object State object
Source:

event_new_test_alarm(alarmInfo)

a new testalarm shall be sent
Parameters:
Name Type Description
alarmInfo object alarm object
Source:

event_new_zveialarm(zveiInfo)

a new alarm via zvei-code took place
Parameters:
Name Type Description
zveiInfo object zvei object
Source:

event_plugin_notification(namespace, message)

Sends a notification to a plugin addressed by namespace
Parameters:
Name Type Description
namespace string namespace of plugin the message shall be forwarded to
message string payload for the plugin addressed with namespace
Source:

event_pluginConfig_refreshed(namespace)

the configuration for a plugin with namespace has been changed. The plugin shall itself reload the configuration and restart itself and existing services.
Parameters:
Name Type Description
namespace string namespace of the plugin whose config has been changed
Source:

event_print_pdf(pathToPDF)

a pdf document waits for printing to the default printer
Parameters:
Name Type Description
pathToPDF string
Source:

event_refresh_extip(ipInfo)

external ip address has changed
Parameters:
Name Type Description
ipInfo string
Source:

event_send_email(emailInfo)

A new eMail shall be sent
Parameters:
Name Type Description
emailInfo object email info object
Source:

getCountActivePlugingsInbound()

Returns number of active inbound plugins
Source:
Returns:
integer

getCountActivePlugingsOutbound()

Returns number of active outbound plugins
Source:
Returns:
integer

getPluginPath(namespace)

Returns the file path for the plugin identified with namespace
Parameters:
Name Type Description
namespace string namespace of plugin the pluginpath shall be returned for
Source:

getPluginsWithAlarmingByUser()

Returns Array with Plugins which offer alarming which can be configured seperately by user
Source:

initializeConfigFromStore(callback)

Loads the plugins configuration from core database into class member configStore
Parameters:
Name Type Description
callback function success (true or false)
Source:

initializePlugins()

Initializes all Plugins in PluginList which are active
Source:

isPluginActive(namespace)

returns boolean if plugin is configured as active in config store in core database Check is based on configStore information pulled by initializeConfigFromStore.
Parameters:
Name Type Description
namespace string
Source:

isValidPlugin(path)

Checks if plugin is valid (has needed files in path)
Parameters:
Name Type Description
path string base path of plugin directory to be checked
Source:

loadClass(Path, namespace)

instanziates a new class object for given namespace
Parameters:
Name Type Description
Path string filepath to js-file containing the class
namespace * namespace the new class instance shall be registered for
Source:

loadConfigFromStore(namespace)

loads config json from configstore and represents it as an object
Parameters:
Name Type Description
namespace string
Source:

readInboundPluginList()

Reads the inbound plugins
Source:

readOutboundPluginList()

Reads the outbound plugins
Source:

readPluginManifest(path)

Reads plugin manifest and return its content as an object.
Parameters:
Name Type Description
path strign base path of plugin directory to be checked
Source:

registerPluginsInStore(manifest)

Registers Plugin in Core Plugin Store
Parameters:
Name Type Description
manifest object manifest object
Source:

resetManifestForNamespace(namespace)

resets Manifest for given namespace
Parameters:
Name Type Description
namespace string namespace the manifest should be reseted for
Source:

resetPluginInStore(manifest)

Resets Plugin in Core Plugin Store
Parameters:
Name Type Description
manifest object manifest object
Source:

startLogger()

Starts Logging which is provided to all plugins
Source: