Class ControlManager

ControlManager handles OpenC2 command and control interactions, serving as the bridge between OpenC2 Consumers and the Service. It extends EventEmitter to re-emit the events of the OpenC2 Consumer (e.g., command execution, errors, and status updates).

Hierarchy

  • EventEmitter
    • ControlManager

Constructors

constructor

Properties

instance?

Accessors

error

Methods

start stop

Constructors

constructor

  • new ControlManager(
        serviceRegistrySettings: ServiceRegistryOptions<Record<string, any>>,
        logger: LoggerInstance,
        defaultResolver?: ResolverMap,
    ): ControlManager

  • Constructor for the ControlManager class.

    Parameters

    • serviceRegistrySettings: ServiceRegistryOptions<Record<string, any>>

      Service Registry settings, which include the consumer and adapter configurations.

    • logger: LoggerInstance

      Logger instance.

    • OptionaldefaultResolver: ResolverMap

      This is the default resolver map for the OpenC2 interface, which is merged with the resolver map from the service registry settings, if provided. The default value, passed from the Service Registry instance include resolvers for the features:

      • query: health, stats, errors and config
      • start: resources
      • stop: resources

    Returns ControlManager

Properties

Optional Readonlyinstance

instance?: Consumer

OpenC2 Consumer instance

Accessors

error

  • get error(): undefined | Multi

  • Returns the validation error, if exist.

    Returns undefined | Multi

    Multi error, if exist.

Methods

start

  • start(): Promise<void>

  • Starts the OpenC2 Consumer instance.

    Returns Promise<void>

    Promise

stop

  • stop(): Promise<void>

  • Stops the OpenC2 Consumer instance.

    Returns Promise<void>

    Promise

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods