Class Gateway

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

  • EventEmitter
    • Gateway

Implements

Constructors

constructor

Properties

componentId

Accessors

checks consumerMap links name router status

Methods

close removeAllListeners start stop

Events

addListener off on once removeListener

Constructors

constructor

Properties

ReadonlycomponentId

componentId: string = ...

Component identification

Accessors

checks

consumerMap

links

name

  • get name(): string

  • Component name

    Returns string

router

  • get router(): Router

  • Return an Express router with access to errors registry

    Returns Router

status

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

  • Component status

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

Methods

close

  • close(): Promise<void>

  • Close the OpenC2 gateway

    Returns Promise<void>

removeAllListeners

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

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

    Parameters

    • Optionalevent: "error"

      error event

    Returns this

start

  • start(): Promise<void>

  • Connect the OpenC2 underlayer component and perform the startup of the component

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • Disconnect the OpenC2 underlayer component and perform the startup 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

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

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

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

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
Events