Class Component<T, K>`Abstract`

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.

Type Parameters

T
K

Hierarchy (View Summary)

EventEmitter
- Component
  - Consumer
  - Producer

Implements

Layer.App.Service

Index

Constructors

Properties

Accessors

checks links name router status

Methods

close start stop

Events

Constructors

constructor

new Component<T extends ComponentAdapter, K extends ComponentOptions>(
adapter: T,
options: K,
): Component<T, K>
Abstract OpenC2 component implementation.
Type Parameters
- T extends ComponentAdapter
- K extends ComponentOptions
Parameters
- adapter: T
  transport adapter
- options: K
  configuration options
Returns Component<T, K>

Properties

`Readonly`componentId

componentId: string = ...

Component identification

Accessors

checks

get checks(): Checks<any>
Return the status of the Consumer in a standard format

Returns Checks<any>
check object as defined in the draft standard https://datatracker.ietf.org/doc/html/draft-inadarei-api-health-check-05

Implementation of Service.checks

links

get links(): Links
Return links offered by this service

Returns Links
Implementation of Service.links

name

get name(): string
Component name

Returns string
Implementation of Service.name

router

get router(): Router
Return an Express router with access to OpenC2 information

Returns Router
Implementation of Service.router

status

get status(): "pass" | "fail" | "warn"
Component health status

Returns "pass" | "fail" | "warn"
Implementation of Service.status

Methods

close

close(): Promise<void>
Close the OpenC2 component

Returns Promise<void>

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

on

on(event: "error", listener: (error: Crash | Multi | 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 | Multi | 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 status changes.
Parameters
- event: "status"
  status event
- listener: (status: "pass" | "fail" | "warn") => void
  Status event listener
Returns this