Class Container

The container is driven by configuration, that usually stored in JSON or YAML file. The configuration contains a list of components identified by type or locator, followed by component configuration.

On container start it performs the following actions:

• Creates components using their types or calls registered factories to create components 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 container stop actions are performed in reversed order:

• Closes components that implement ICloseable interface
• Unsets references in components that implement IUnreferenceable interface
• Destroys components in the container.

The component configuration can be parameterized by dynamic values. That allows specialized containers to inject parameters from command line or from environment variables.

The container automatically creates a ContextInfo component that carries detail information about the container and makes it available for other components.

see

IConfigurable (in the PipServices "Commons" package)

see

IReferenceable (in the PipServices "Commons" package)

see

IOpenable (in the PipServices "Commons" package)

Configuration parameters

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

   - ...
  

Example

======= config.yml ========
- 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("123", "./config/config.yml", parameters);

container.open("123", (err) => {
    console.log("Container is opened");
    ...
    container.close("123", (err) => {
        console.log("Container is closed");
    });
});