centralconfig

Documentation

Overview

Package centralconfig implements an interface to deal with the central configuration.

Package centralconfig implements an interface to deal with the central configuration.

Index

• type CentralConfig
  • func NewCentralConfigReader(pd *types.PluginDiscovery) CentralConfig
• type KeyNotFoundError
  • func (e *KeyNotFoundError) Error() string

Types

type CentralConfig

type CentralConfig interface {
	// GetCentralConfigEntry reads the central configuration and
	// returns the value for the given key. The value is unmarshalled
	// into the out parameter. The out parameter must be a non-nil
	// pointer to a value.  If the key does not exist, the out parameter
	// is not modified and an error is returned.
	GetCentralConfigEntry(key string, out interface{}) error
}

CentralConfig is used to interact with the central configuration.

func NewCentralConfigReader

func NewCentralConfigReader(pd *types.PluginDiscovery) CentralConfig

NewCentralConfigReader returns a CentralConfig reader that can be used to read central configuration values.

type KeyNotFoundError

type KeyNotFoundError struct {
	Key string
}

KeyNotFoundError represents an error when the key is not found in the central configuration.

func (*KeyNotFoundError) Error

func (e *KeyNotFoundError) Error() string