Reference Source
public class | source

RoutableServer

Extends:

devapt-core-common/dist/js/base/distributed_instance~DistributedInstanceServer → RoutableServer

Direct Subclass:

ExpressServer, RestifyServer

Constructor Summary

Public Constructor
public

constructor(arg_name: string, arg_class: string, arg_settings: object, arg_log_context: string): nothing

Base class for a routable server instance.

Member Summary

Public Members
public

Method Summary

Public Methods
public

add_get_route(arg_cfg_route: object, arg_callback: function): boolean

Get server middleware for directory route.

public

disable(): nothing

Disable server (stop it).

public

enable(): nothing

Enable server (start it).

public

get_middleware_for_static_route(arg_cfg_route: object): middleware

Get server middleware for static route.

Inherited Summary

From class Server
public
public
public
public

server: *

public
public
public
public
public
public
public
public
public

build_server(): nothing

Build private server instance.

public

disable(): nothing

Disable server (stop it).

public

enable(): nothing

Enable server (start it).

public

get_security_settings(): Immutable.Map

Get security settings from server or runtime.

public

Get security settings object into the server.

public

get_topology_info(arg_deep: boolean, arg_visited: object): object

Get topology item informations.

public

load(): nothing

Load server settings.

public

use_service_on_loading(arg_application: Application, arg_service: Service, arg_app_svc_cfg: object): nothing

Add a service to use before or after security check.

Public Constructors

public constructor(arg_name: string, arg_class: string, arg_settings: object, arg_log_context: string): nothing source

Base class for a routable server instance.

Override:

Server#constructor

Params:

NameTypeAttributeDescription
arg_name string

server name.

arg_class string

server class name.

arg_settings object

plugin settings map.

arg_log_context string

trace context string.

Return:

nothing

Public Members

public is_routable_server: boolean source

Public Methods

public add_get_route(arg_cfg_route: object, arg_callback: function): boolean source

Get server middleware for directory route.

Params:

NameTypeAttributeDescription
arg_cfg_route object

plain object route configuration.

arg_callback function

route handler callback.

Return:

boolean

success or failure.

public disable(): nothing source

Disable server (stop it).

Override:

Server#disable

Return:

nothing

public enable(): nothing source

Enable server (start it).

Override:

Server#enable

Return:

nothing

public get_middleware_for_static_route(arg_cfg_route: object): middleware source

Get server middleware for static route.

Params:

NameTypeAttributeDescription
arg_cfg_route object

plain object route configuration.

Return:

middleware

middleware function as f(req, res, next)