settings

Documentation

Overview

Package settings defines the interface for the component that manage settings that can be changed at runtime

Index

• type Component
• type Params
• type RuntimeSetting
• type RuntimeSettingProvider
  • func NewRuntimeSettingProvider(runtimesetting RuntimeSetting) RuntimeSettingProvider
• type RuntimeSettingResponse
• type SettingNotFoundError
  • func (e *SettingNotFoundError) Error() string

Types

type Component

type Component interface {
	// RuntimeSettings returns the configurable settings
	RuntimeSettings() map[string]RuntimeSetting
	// GetRuntimeSetting returns the value of a runtime configurable setting
	GetRuntimeSetting(setting string) (interface{}, error)
	// SetRuntimeSetting changes the value of a runtime configurable setting
	SetRuntimeSetting(setting string, value interface{}, source model.Source) error

	// API related functions
	// Todo: (Components) Remove these functions once we can register routes using FX value groups
	// GetFullConfig returns the full config
	GetFullConfig(namespaces ...string) http.HandlerFunc
	// GetValue allows to retrieve the runtime setting
	GetValue(setting string, w http.ResponseWriter, r *http.Request)
	// SetValue allows to modify the runtime setting
	SetValue(setting string, w http.ResponseWriter, r *http.Request)
	// ListConfigurable returns the list of configurable setting at runtime
	ListConfigurable(w http.ResponseWriter, r *http.Request)
}

Component is the component type.

type Params

type Params struct {
	// Settings define the runtime settings the component would understand
	Settings map[string]RuntimeSetting
	// The config object in which the settings would apply operations
	Config config.Component
}

Params that the settings component need

type RuntimeSetting

type RuntimeSetting interface {
	Get(config config.Component) (interface{}, error)
	Set(config config.Component, v interface{}, source model.Source) error
	Description() string
	Hidden() bool
}

RuntimeSetting represents a setting that can be changed and read at runtime.

type RuntimeSettingProvider

type RuntimeSettingProvider struct {
	fx.Out

	Setting RuntimeSetting `group:"runtime_setting"`
}

RuntimeSettingProvider stores the Provider instance

func NewRuntimeSettingProvider

func NewRuntimeSettingProvider(runtimesetting RuntimeSetting) RuntimeSettingProvider

NewRuntimeSettingProvider returns a RuntimeSettingProvider

type RuntimeSettingResponse

type RuntimeSettingResponse struct {
	Description string
	Hidden      bool
}

RuntimeSettingResponse is used to communicate settings config

type SettingNotFoundError

type SettingNotFoundError struct {
	Name string
}

SettingNotFoundError is used to warn about non existing/not registered runtime setting

func (*SettingNotFoundError) Error

func (e *SettingNotFoundError) Error() string