Class Producer

constructor

• new Producer(adapter: ProducerAdapter, options: ProducerOptions): Producer

• Regular OpenC2 producer implementation.

  Parameters

  • adapter: ProducerAdapter

    transport adapter
  • options: ProducerOptions

    configuration options

  Returns Producer

ReadonlycomponentId

ReadonlyconsumerMap

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

links

• get links(): Links

• Return links offered by this service

  Returns Links

name

• get name(): string

• Component name

  Returns string

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"

close

• close(): Promise<void>

• Close the OpenC2 component

  Returns Promise<void>

command

• command(command: CommandMessage): Promise<ResponseMessage[]>

• Issue a new command to the requested consumers. If '' is indicated as a consumer, the command will be broadcasted. If an actuator is indicated in the command the command will not be broadcasted even if it include the '' symbol.

  Parameters

  • command: CommandMessage

    Command to be issued

  Returns Promise<ResponseMessage[]>
• command(to: string[], content: Command): Promise<ResponseMessage[]>

• Issue a new command to the requested consumers. If '' is indicated as a consumer, the command will be broadcasted. If an actuator is indicated in the command the command will not be broadcasted even if it include the '' symbol.

  Parameters

  • to: string[]

    Consumer objetive of this command
  • content: Command

    Command to be issued

  Returns Promise<ResponseMessage[]>
• command(
      to: string[],
      action: Action,
      target: Target,
  ): Promise<ResponseMessage[]>

• Issue a new command to the requested consumers. If '*' is indicated as a consumer, the command will be broadcasted.

  Parameters

  • to: string[]

    Consumer objetive of this command
  • action: Action

    command action
  • target: Target

    command target

  Returns Promise<ResponseMessage[]>

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 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>

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