import TopologyDeployItem from 'devapt-core-common/js/topology/deploy/topology_deploy_item.js'

public class | source

TopologyDeployItem

Extends:

Loggable → Errorable → Settingsable → Stateable → Instance → DistributedInstance → TopologyDeployItem

Direct Subclass:

TopologyDeployLocalNode

Constructor Summary

Public Constructor
public	constructor(arg_name: string, arg_definition_item: TopologyDefineItem, arg_deploy_settings: object, arg_topology_class: class, arg_log_context: string): nothing Create a topology deploy item instance.

Member Summary

Public Members
public	[arg_plural_name]: *
public	[arg_single_name]: *
public	is_topology_deploy_item: boolean
public	topology_children: {}
public	topology_definition_item: *
public	topology_owner: *

Method Summary

Public Methods
public	declare_collection(arg_plural_name: string, arg_single_name: string, arg_topology_class: class, arg_init_cb: function): nothing Load a collection of topology items.
public	dump_topology_info(arg_info: object): nothing Dump topology item informations.
public	get_children(): object Get topology children items.
public	get_children_names(): * Get children names
public	get_topology_definition_item(): * Get topology definition item.
public	get_topology_info(arg_deep: boolean, arg_visited: object): object Get topology item informations.
public	get_topology_owner(): * Get topology owner.
public	get_topology_package(): * Get resource topology package.
public	get_topology_security(): * Get resource topology security.
public	get_topology_tenant(): * Get resource topology tenant.
public	get_topology_type(): * Get resource topology type.
public	get_topology_uid(): * Get resource topology uid.
public	get_topology_uid_desc(): * Get resource topology uid description.
public	get_topology_version(): * Get resource topology version.
public	is_valid(): boolean Check functional format.
public	load(): Promise Load Topology item settings.
public	load_collection(arg_collection_name: string, arg_collection: object, arg_topology_class: class, arg_init_cb: function): Promise Load a collection of topology items.

Inherited Summary

From class Loggable
public	$context: string Log context.
public	is_loggable: boolean Class type flag.
public	is_trace_enabled: boolean Trace is enabled for this flag.
private	_logger_manager: LoggerManager Logger manager instance (default undefined)
public	debug(args: string \| array): nothing Trace DEBUG formatted message.
public	disable_trace(): nothing Disable traces.
public	enable_trace(): nothing Enable traces.
public	enter_group(arg_group: string): nothing Trace INFO message on "enter trace group".
public	error(args: string \| array): nothing Trace ERROR formatted message.
public	get_class(): string Define get class name method for non Instance classes.
public	get_context(): string Get instance context.
public	get_logger_manager(): LoggerManager Get logger manager.
public	get_name(): string Define get instance name method for non Instance classes.
public	get_trace(): boolean Get trace flag.
public	info(args: string \| array): nothing Trace INFO formatted message.
public	leave_group(arg_group: string): nothing Trace INFO message on "leave trace group".
public	separate_level_1(): nothing Trace INFO trace level 1 separator.
public	separate_level_2(): nothing Trace INFO trace level 2 separator.
public	separate_level_3(): nothing Trace INFO trace level 3 separator.
public	set_trace(arg_value: boolean): nothing Set trace flag.
public	should_trace(arg_traces_cfg: object): boolean Calculate should trace flag.
public	should_trace_class(arg_traces_cfg: object): boolean Calculate should trace flag for classes.
public	should_trace_collection_item(arg_traces_cfg: object, arg_collection_name: string, arg_this_item_accessor: string): boolean Calculate should trace flag for given collection of names or patterns.
public	should_trace_module(arg_traces_cfg: object): boolean Calculate should trace flag for modules.
public	should_trace_name(arg_traces_cfg: object): boolean Calculate should trace flag for instances names.
public	toggle_trace(): boolean Toggle trace flag.
public	update_trace_enabled(): nothing Update trace enabled flag.
public	warn(args: string \| array): nothing Trace WARN formatted message.

From class Errorable
private	_error_msg: string Error text (default null).
private	_has_error: boolean Has error flag (default false).
public	error(arg_msg: string): nothing Set an error.
public	error_not_implemented() Default helper for "not implemented" error.
public	get_error_msg(): string Get error message.
public	has_error(): boolean Test is an error is set.

From class Settingsable
public	$settings: object \| Immutable.Map Instance settings (default undefined).
public	is_settable: boolean Class type flag.
public	get_setting(arg_name: string \| array, arg_default: any): any Get a value in settings for given key.
public	get_setting_js(arg_name: string \| array, arg_default: any): any Get a value in settings for given key.
public	get_settings(): Immutable.Map Get instance settings.
public	get_settings_js(): Immutable.Map Get instance settings.
public	has_setting(arg_name: string): boolean Test if a key exists in settings.
public	set_setting(arg_name: string, arg_value: any): nothing Set a value in settings for given key.
public	set_settings(arg_settings: Immutable.Map): nothing Set instance settings.

From class Stateable
public	is_stateable: boolean Class type flag.
public	state_path: array State path in runtime state.
private	_initial_state: object Initial state.
private	_runtime: Runtime Runtime isntance.
private	_state_store: StateStore State store.
private	_state_value_listeners: array State changes handlers.
public	dispatch_action(arg_action_type: string \| object, arg_options: object \| undefined): nothing Dispatch a state action.
public	get_initial_state(): Immutable.Map Get initial state, an immutable object from a Redux data store.
public	get_name(): string Get name.
public	get_runtime(): RuntimeBase Get runtime instance.
public	get_state(): Immutable.Map Get current state, an immutable object from a Redux data store.
public	get_state_js(): object Get current state, an immutable object from a Redux data store.
public	get_state_path(): array Get state path into a Redux data store.
public	get_state_store(): object Get state store.
public	get_state_value(arg_key_or_path: string \| array, arg_default_value: any): any Get a state entry.
public	handle_state_change(arg_previous_state: Immutable.Map, arg_new_state: Immutable.Map): nothing Handle component state changes.
public	register_state_value_change_handle(arg_path: string \| array, arg_listener: string \| function): nothing Register a state value change listener.

From class Instance
public	$class: string Instance class name.
public	$id: string Instance id.
public	$name: string Instance name.
public	$type: string Instance collection name.
public	is_instance: boolean Class type flag.
public	is_loaded: boolean Instance is loaded flag.
public	get_class(): string Get instance class.
public	get_descriptor(): object Get instance description: {$type:..., $class:..., $id:..., $name:...}.
public	get_descriptor_string(): string Get instance description string: $type:..., $class:..., $id:..., $name:....
public	get_id(): string Get instance unique id.
public	get_name(): string Get instance unique name.
public	get_type(): string Get instance type.
public	is_browser(): boolean Test if this code run inside a browser.
public	is_server(): boolean Test if this code run on a browser.
public abstract	load(): nothing Load instance settings.

From class DistributedInstance
public	is_distributed_instance: boolean Class type flag.
private	_bus_unsubscribes: object Bus unsubscribes handlers map.
private	_logs_bus: MessageBus Logs messages bus instance.
private	_metrics_bus: MessageBus Metrics messages bus instance.
private	_msg_bus: MessageBus Messages bus instance.
public	disable_logs(): nothing Disable distributed logs.
public	disable_metrics(): nothing Disable distributed metrics.
public	disable_msg(): nothing Disable distributed messaging.
public	disable_on_bus(arg_bus: MessageBus, arg_channel: string): nothing Disable distributed messaging.
public	enable_logs(): nothing Enable distributed logs.
public	enable_metrics(): nothing Enable distributed metrics.
public	enable_msg(): nothing Enable distributed messaging.
public	enable_on_bus(arg_bus: MessageBus, arg_channel: string, arg_method: string, arg_alias: string): nothing Enable distributed messaging.
public	load(): nothing Load instance settings.
public	load_topology_settings(arg_settings: object): nothing Load topology settings.
public	receive_logs(arg_msg: DistributedLogs): nothing Process received logs message (to override in sub classes).
public	receive_metrics(arg_msg: DistributedMetrics): nothing Process received metrics message (to override in sub classes).
public	receive_msg(arg_msg: DistributedMessage): nothing Process received message (to override in sub classes).
public	send(arg_msg: DistributedMessage): boolean Send a message to an other client.
public	send_logs(arg_target_name: string, arg_timestamp: string, arg_level: string, arg_values: array): boolean Send a logs message.
public	send_metrics(arg_target_name: string, arg_metric_type: string, arg_metrics: array): boolean Send a metrics message.
public	send_msg(arg_target_name: string, arg_payload: object, arg_channel: string): boolean Create and send a message to an other client.

Public Constructors

public constructor(arg_name: string, arg_definition_item: TopologyDefineItem, arg_deploy_settings: object, arg_topology_class: class, arg_log_context: string): nothing source

Create a topology deploy item instance.

Override:

DistributedInstance#constructor

Params:

Name	Type	Attribute	Description
arg_name	string		instance name.
arg_definition_item	TopologyDefineItem		topology definition item.
arg_deploy_settings	object		deployment settings map.
arg_topology_class	class		item TopologyDefineItem child class.
arg_log_context	string		trace context string.

Return:

nothing

Public Members

public [arg_plural_name]: * source

public [arg_single_name]: * source

public is_topology_deploy_item: boolean source

public topology_children: {} source

public topology_definition_item: * source

public topology_owner: * source

Public Methods

public declare_collection(arg_plural_name: string, arg_single_name: string, arg_topology_class: class, arg_init_cb: function): nothing source

Load a collection of topology items.

Params:

Name	Type	Attribute	Description
arg_plural_name	string		plural name of the collection.
arg_single_name	string		single name of the collection item.
arg_topology_class	class		item TopologyDeployItem child class.
arg_init_cb	function		optional callback to complete item loading:(name,settings)=>Promise(boolean).

Return:

nothing

public dump_topology_info(arg_info: object): nothing source

Dump topology item informations.

Params:

Name	Type	Attribute	Description
arg_info	object		topology info object.

Return:

nothing

public get_children(): object source

Get topology children items.

Return:

object

map of children items.

public get_children_names(): * source

Get children names

Return:

public get_topology_definition_item(): * source

Get topology definition item.

return {TopologyDefineItem}

Return:

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

Get topology item informations.

Params:

Name	Type	Attribute	Description
arg_deep	boolean		get deep sub items information on true (default:true).
arg_visited	object		visited items plain object map (default:{}).

Return:

object

topology informations (plain object).

public get_topology_owner(): * source

Get topology owner.

returns {TopologyDeployItem}

Return:

public get_topology_package(): * source

Get resource topology package.

Return:

public get_topology_security(): * source

Get resource topology security.

Return:

public get_topology_tenant(): * source

Get resource topology tenant.

Return:

public get_topology_type(): * source

Get resource topology type.

Return:

public get_topology_uid(): * source

Get resource topology uid.

Return:

public get_topology_uid_desc(): * source

Get resource topology uid description.

Return:

public get_topology_version(): * source

Get resource topology version.

Return:

public is_valid(): boolean source

Check functional format.

Return:

boolean

public load(): Promise source

Load Topology item settings.

Override:

DistributedInstance#load

Return:

Promise

Promise(boolean): true=success, false=failure

public load_collection(arg_collection_name: string, arg_collection: object, arg_topology_class: class, arg_init_cb: function): Promise source

Load a collection of topology items.

Params:

Name	Type	Attribute	Description
arg_collection_name	string		name of the collection in the item settings.
arg_collection	object		child collection of items.
arg_topology_class	class		item TopologyDeployItem child class.
arg_init_cb	function		optional callback to complete item loading:(name,settings)=>Promise(boolean).

Return:

Promise

Promise(boolean): true=success, false=failure.