notifier

Documentation

Overview

Package notifier fetches notifications from the database and informs the specified remote handler about their existences, inviting the third party to actively query the API about it.

Index

• func RegisterNotifier(name string, n Notifier)
• func Run(config *config.NotifierConfig, datastore database.Datastore, ...)
• type Notifier

Functions

func RegisterNotifier

func RegisterNotifier(name string, n Notifier)

RegisterNotifier makes a Fetcher available by the provided name. If Register is called twice with the same name or if driver is nil, it panics.

func Run

func Run(config *config.NotifierConfig, datastore database.Datastore, stopper *utils.Stopper)

Run starts the Notifier service.

Types

type Notifier

type Notifier interface {
	// Configure attempts to initialize the notifier with the provided configuration.
	// It returns whether the notifier is enabled or not.
	Configure(*config.NotifierConfig) (bool, error)
	// Send informs the existence of the specified notification.
	Send(notification database.VulnerabilityNotification) error
}

Notifier represents anything that can transmit notifications.