Node

Introduction

The Node module is responsible for deploying (starting) and un-deploying (stopping) a group of modules to form an application.

Module based applications use the Node module to bootstrap and the application configuration file (in JSON format) is passed as is (after include and expansion) to the Node module which processes the modules part of the file.

This module is never deployed by configuration.

Configuration

Properties

Name	Description	Default	Mandatory
groups	List of module groups defining the order of deployment.	[ "first", "system", "authn", "default", "last" ]
modules	List of modules to deploy. If empty or non-existing no modules will be deployed.	[]
heartbeat	HTTP heartbeat configuration object (see below).	{ "enabled": false }

Example

{
  "groups": "first,default,last",
  "modules": [
    {
      "name": "<module-name-01>",
      "enabled": true,
      "group": "first",
      "config": {
      }
    },
    {
      "name": "<module-name-02>",
      "enabled": false
      "config": {
      }
    }    
  ],
  "heartbeat": {
    "enabled": false
  } 
}

Module

A module object represent a module to deploy. All modules defines their own configuration, documented separately.

Module deployment order is defined by groups, all modules in the first group are deployed before modules in the next, and so on. If a module has no group defined it will be added to the default group.

Properties

Name	Description	Default	Mandatory
name	Module class name or alias
enabled	Flag controlling if module should be deployed or not	true
group	Module deployment group	"default"
config	JSON object containing the module configuration.	{}

Example

{
  "name": "<module-name-or-alias>",
  "enabled": true
  "config": {
  }
}

Heartbeat

The Node module supports HTTP heartbeat.

The heartbeat responder supports all HTTP module configuration properties and is started when all configured moduled has been successfully started (i.e. when the application is started and ready to receive requests).

By default the heartbeat responder uses the following URL: http://<host-or-ip>:8080/heartbeat

Since the heartbeat configuration is used by the Node module, which serves as the default bootstrap module, it must be placed at the top level in config.json.

Properties

Name	Description	Default	Mandatory
enabled	Flag to enable heartbeat	false
http_listener	Name/id of theHTTP listener to use. If not specified default settings will be used.
http_context	Responder base HTTP context.	"/heartbeat"
context_path	Responder HTTP context path. This property is appended to http_context to form the full context ("path") of the responder.	"/*"

Examples

{
  "heartbeat": {
    "enabled": true,
    "http_listener": "default-8080"
    "http_context": "/node01",
    "context_path": "/hb"
  }
}