Container

Implements: IConfigurable interface, IReferenceable interface, IUnreferenceable interface, IOpenable interface

Description

The Container class allows you to create an inversion of control (IoC) container that creates components and manages their lifecycle.

Important points

• The container is driven by configuration, which is usually stored in a JSON or YAML file.
• The configuration contains a list of components identified by their type or locator, followed by their configuration.
• On start, a container performs the following actions:
  • Creates components using their types or calls registered factories to create them using their locators.
  • Configures components that implement IConfigurable interface and passes them their configuration parameters.
  • Sets references to components that implement IReferenceable interface and passes them references of all components in the container.
  • Opens components that implement IOpenable interface.
• On stop, a container reverses the orden of its actions:
  • Closes components that implement IClosable interface
  • Unsets references in components that implement IUnreferenceable interface
  • Destroys components in the container.

Configuration parameters

• name: context (container or process) name
• description: human-readable description of the context
• properties: section of additional descriptive properties
  • …

Constructors

Creates a new instance of the container.

public constructor(name?: string, description?: string)

• name: string - (optional) container’s name (accessible via ContextInfo)
• description: string - (optional) container’s description (accessible via ContextInfo)

Fields

Instance methods

addFactory

Adds a factory to the container. The factory is used to create components
added to the container by their locators (descriptors).

public addFactory(factory: IFactory): void

• factory: IFactory - component factory to be added.

close

Closes the component and frees used resources.

public close(context: IContext): Promise<void>

• context: IContext - (optional) a context to trace execution through call chain.

configure

Configures the component by passing its configuration parameters.

public configure(config: ConfigParams): void

• config: ConfigParams - configuration parameters to be set.

isOpen

Checks if the component is open.

public isOpen(): boolean

• returns: boolean - True if the component is open and false otherwise.

open

Opens the component.

public open(context: IContext): Promise<void>

• context: IContext - (optional) a context to trace execution through call chain.

readConfigFromFile

Reads the container’s configuration from a JSON or YAML file and parameterizes it with the given values.

public readConfigFromFile(context: IContext, path: string, parameters: ConfigParams): void

• context: IContext - (optional) a context to trace execution through call chain.
• path: string - path to the configuration file
• parameters: ConfigParams - configuration parameters or null to skip parameterization.

setReferences

Sets references to dependent components.

public setReferences(references: IReferences): void

• references: IReferences - references to locate the component dependencies.

unsetReferences

Unsets (clears) previously set references to dependent components.

public unsetReferences()

Examples

======= config.yaml ========
- descriptor: mygroup:mycomponent1:default:default:1.0
param1: 123
param2: ABC
- type: mycomponent2,mypackage
param1: 321
param2: XYZ
============================

let container = new Container();
container.addFactory(new MyComponentFactory());
     
let parameters = ConfigParams.fromValue(process.env);
container.readConfigFromFile(new Context(), "./config/config.yml", parameters);
   
await container.open(new Context());
console.log("Container is opened");
...
await container.close(new Context());
console.log("Container is closed");

See also

• IConfigurable interface

• IReferenceable interface

• IUnreferenceable interface

• IOpenable interface