Class Consumer

A service is a special kind of resource that besides Resource properties, it could offer:

  • Its own REST API endpoints, using an express router, to expose details about service, this endpoints will be exposed under the observability paths.
  • A links property to define the endpoints that the service expose, this information will be exposed in the observability paths.
  • A metrics property to expose the metrics of the service, this registry will be merged with the global metrics registry.

Hierarchy (View Summary)

Constructors

constructor

Properties

componentId

Accessors

actuator checks links name pairs profiles router status

Methods

close removeAllListeners start stop

Events

addListener off on once removeListener

Constructors

constructor

Properties

ReadonlycomponentId

componentId: string = ...

Component identification

Accessors

actuator

  • get actuator(): undefined | string[]

  • Consumer actuators

    Returns undefined | string[]

  • set actuator(value: undefined | string[]): void

  • Parameters

    • value: undefined | string[]

    Returns void

checks

links

  • Return links offered by this service

    Returns Links

name

  • get name(): string

  • Component name

    Returns string

pairs

profiles

  • get profiles(): undefined | string[]

  • Consumer profiles

    Returns undefined | string[]

  • set profiles(value: undefined | string[]): void

  • Parameters

    • value: undefined | string[]

    Returns void

router

  • get router(): Router

  • Return an Express router with access to OpenC2 information

    Returns Router

status

  • get status(): "pass" | "fail" | "warn"

  • Component health status

    Returns "pass" | "fail" | "warn"

Methods

close

  • close(): Promise<void>

  • Close the OpenC2 component

    Returns Promise<void>

removeAllListeners

  • removeAllListeners(event?: "error"): this

  • Removes all listeners, or those of the specified event.

    Parameters

    • Optionalevent: "error"

      error event

    Returns this

  • removeAllListeners(event?: "command"): this

  • Removes all listeners, or those of the specified event.

    Parameters

    • Optionalevent: "command"

      command event

    Returns this

start

  • start(): Promise<void>

  • Connect the OpenC2 Adapter to the underlayer transport system and perform the startup of the component

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • Disconnect the OpenC2 Adapter to the underlayer transport system and perform the shutdown of the component

    Returns Promise<void>

Events

addListener

  • addListener(event: "error", listener: (error: Crash | Error) => void): this

  • Add a listener for the error event, emitted when the component detects an error.

    Parameters

    • event: "error"

      error event

    • listener: (error: Crash | Error) => void

      Error event listener

    Returns this

  • addListener(
        event: "status",
        listener: (status: "pass" | "fail" | "warn") => void,
    ): this

  • Add a listener for the status event, emitted when the component changes its status.

    Parameters

    • event: "status"

      status event

    • listener: (status: "pass" | "fail" | "warn") => void

      Status event listener

    Returns this

  • addListener(event: "command", listener: (job: CommandJobHandler) => void): this

  • Add a listener for the command event, emitted when a new command is received

    Parameters

    • event: "command"

      command event

    • listener: (job: CommandJobHandler) => void

      Command event listener

    Returns this

off

  • off(event: "error", listener: (error: Crash | Error) => void): this

  • Removes the specified listener from the listener array for the error event.

    Parameters

    • event: "error"

      error event

    • listener: (error: Crash | Error) => void

      Error event listener

    Returns this

  • off(event: "status", listener: (status: "pass" | "fail" | "warn") => void): this

  • Removes the specified listener from the listener array for the status event.

    Parameters

    • event: "status"

      status event

    • listener: (status: "pass" | "fail" | "warn") => void

      Status event listener

    Returns this

  • off(event: "command", listener: (job: CommandJobHandler) => void): this

  • Removes the specified listener from the listener array for the command event.

    Parameters

    • event: "command"

      command event

    • listener: (job: CommandJobHandler) => void

      Command event listener

    Returns this

on

  • on(event: "error", listener: (error: Crash | Error) => void): this

  • Add a listener for the error event, emitted when the component detects an error.

    Parameters

    • event: "error"

      error event

    • listener: (error: Crash | Error) => void

      Error event listener

    Returns this

  • on(event: "status", listener: (status: "pass" | "fail" | "warn") => void): this

  • Add a listener for the status event, emitted when the component changes its status.

    Parameters

    • event: "status"

      status event

    • listener: (status: "pass" | "fail" | "warn") => void

      Status event listener

    Returns this

  • on(event: "command", listener: (job: CommandJobHandler) => void): this

  • Add a listener for the command event, emitted when a new command is received

    Parameters

    • event: "command"

      command event

    • listener: (job: CommandJobHandler) => void

      Command event listener

    Returns this

once

  • once(event: "error", listener: (error: Crash | Error) => void): this

  • Add a listener for the error event, emitted when the component detects an error. This is a one-time event, the listener will be removed after the first emission.

    Parameters

    • event: "error"

      error event

    • listener: (error: Crash | Error) => void

      Error event listener

    Returns this

  • once(
        event: "status",
        listener: (status: "pass" | "fail" | "warn") => void,
    ): this

  • Add a listener for the status event, emitted when the component changes its status. This is a one-time event, the listener will be removed after the first emission.

    Parameters

    • event: "status"

      status event

    • listener: (status: "pass" | "fail" | "warn") => void

      Status event listener

    Returns this

  • once(event: "command", listener: (job: CommandJobHandler) => void): this

  • Add a listener for the command event, emitted when a new command is received. This is a one-time event, the listener will be removed after the first emission.

    Parameters

    • event: "command"

      command event

    • listener: (job: CommandJobHandler) => void

      Command event listener

    Returns this

removeListener

  • removeListener(event: "error", listener: (error: Crash | Error) => void): this

  • Removes the specified listener from the listener array for the error event.

    Parameters

    • event: "error"

      error event

    • listener: (error: Crash | Error) => void

      Error event listener

    Returns this

  • removeListener(
        event: "status",
        listener: (status: "pass" | "fail" | "warn") => void,
    ): this

  • Removes the specified listener from the listener array for the status event.

    Parameters

    • event: "status"

      status event

    • listener: (status: "pass" | "fail" | "warn") => void

      Status event listener

    Returns this

  • removeListener(
        event: "command",
        listener: (job: CommandJobHandler) => void,
    ): this

  • Removes the specified listener from the listener array for the command event.

    Parameters

    • event: "command"

      command event

    • listener: (job: CommandJobHandler) => void

      Command event listener

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events