Skip to content
Baumbart logo Baumbart Documentation

qanary-component-core/services/registration/registration.service

This page is auto-generated from TSDoc output. Edit the source file, not this Markdown.

qanary-component-core/services/registration/registration.service

Section titled “qanary-component-core/services/registration/registration.service”
  • Package: @leipzigtreechat/qanary-component-core
  • Source file: packages/qanary-component-core/src/services/registration/registration.service.ts

Summary

Section titled “Summary”

The internal in which the service registers with the pipeline again in Milliseconds

Functions

Section titled “Functions”

callAdminServer

Section titled “callAdminServer”
function callAdminServer(config: QanaryComponentCoreServiceConfig, registration: RegistrationInfo): void

Calls the Spring Boot Admin Server to register the component by sending a POST request

Parameters

  • config (QanaryComponentCoreServiceConfig): the configuration of the component
  • registration (RegistrationInfo): the registration information of the component Defined at: line 33

registrationService

Section titled “registrationService”
function registrationService(config: QanaryComponentCoreServiceConfig, interval: unknown): void

Registers the component/service at the Spring Boot Admin Server and makes it available for the Qanary Pipeline

Parameters

  • config (QanaryComponentCoreServiceConfig): the configuration of the component
  • interval (unknown): the interval in which the component should call the Spring Boot Admin Server Defined at: line 63

Enums

Section titled “Enums”

SUBSCRIPTION_STATUS

Section titled “SUBSCRIPTION_STATUS”
enum SUBSCRIPTION_STATUS

The possible connections between the Spring Boot Admin and this instance

Properties

  • UNKNOWN (enum-member): the initial subscription status
  • SUBSCRIBED (enum-member): the status if subscribing was successful
  • DETACHED (enum-member): the status if subscribing was not successfull Defined at: line 14

Constants

Section titled “Constants”

RENEW_REGISTRATION_INTERVAL

Section titled “RENEW_REGISTRATION_INTERVAL”
const RENEW_REGISTRATION_INTERVAL: number

The internal in which the service registers with the pipeline again in Milliseconds

Defined at: line 9

Members

Section titled “Members”

subscriptionStatus

Section titled “subscriptionStatus”
let subscriptionStatus: SUBSCRIPTION_STATUS

The status of the connection between the Spring Boot Admin and this component

Defined at: line 26

In qanary-component-core

Section titled “In qanary-component-core”