gappconfig

README

gapp-config

Documentation

Index

• Constants
• Variables
• func GetConfig(c gapp.ServiceContainer) (gconfig.Manager, error)
• func GetDecoderFactory(c gapp.ServiceContainer) (*gconfig.DecoderFactory, error)
• func GetDecoderStrategies(c gapp.ServiceContainer) ([]gconfig.DecoderStrategy, error)
• func GetLoader(c gapp.ServiceContainer) (*gconfig.Loader, error)
• func GetSourceFactory(c gapp.ServiceContainer) (*gconfig.SourceFactory, error)
• func GetSourceStrategies(c gapp.ServiceContainer) ([]gconfig.SourceStrategy, error)
• type Provider
  • func (p Provider) Boot(c gapp.ServiceContainer) error
  • func (p Provider) Register(c gapp.ServiceContainer) error

Constants

const (
	// ContainerID defines the id to be used as the container
	// registration id of a config instance, as a base id of all other config
	// package instances registered in the application container.
	ContainerID = gapp.ContainerID + ".config"

	// ContainerDecoderStrategyTag defines the tag to be assigned to all
	// container decoders strategies.
	ContainerDecoderStrategyTag = ContainerID + ".decoder.strategy"

	// ContainerDecoderStrategyYAMLID defines the id to be used as the
	// container registration id of a yaml config decoder factory strategy
	// instance.
	ContainerDecoderStrategyYAMLID = ContainerID + ".decoder.strategy.yaml"

	// ContainerDecoderStrategyJSONID defines the id to be used as the
	// container registration id of a json config decoder factory strategy
	// instance.
	ContainerDecoderStrategyJSONID = ContainerID + ".decoder.strategy.json"

	// ContainerDecoderFactoryID defines the id to be used as the
	// container registration id of a config decoder factory instance.
	ContainerDecoderFactoryID = ContainerID + ".decoder.factory"

	// ContainerSourceStrategyTag defines the tag to be assigned to all
	// container source strategies.
	ContainerSourceStrategyTag = ContainerID + ".source.strategy"

	// ContainerSourceStrategyFileID defines the id to be used as the
	// container registration id of a config file source factory strategy
	// instance.
	ContainerSourceStrategyFileID = ContainerID + ".source.strategy.file"

	// ContainerSourceStrategyFileObservableID defines the id to be used
	// as the container registration id of a config observable file source
	// factory strategy instance.
	ContainerSourceStrategyFileObservableID = ContainerID + ".source.strategy.file_observable"

	// ContainerSourceStrategyDirID defines the id to be used as the
	// container registration id of a config dir source factory strategy
	// instance.
	ContainerSourceStrategyDirID = ContainerID + ".source.strategy.dir"

	// ContainerSourceStrategyRemoteID defines the id to be used as the
	// container registration id of a config remote source factory strategy
	// instance.
	ContainerSourceStrategyRemoteID = ContainerID + ".source.strategy.remote"

	// ContainerSourceStrategyRemoteObservableID defines the id to be used
	// as the container registration id of a config observable remote source
	// factory strategy instance.
	ContainerSourceStrategyRemoteObservableID = ContainerID + ".source.strategy.remote_observable"

	// ContainerSourceStrategyEnvID defines the id to be used as
	// the container registration id of a config environment source
	// factory strategy instance.
	ContainerSourceStrategyEnvID = ContainerID + ".source.strategy.env"

	// ContainerSourceFactoryID defines the id to be used as the
	// container registration id config source factory instance.
	ContainerSourceFactoryID = ContainerID + ".source.factory"

	// ContainerLoaderID defines the id to be used as the container
	// registration id of a config loader instance.
	ContainerLoaderID = ContainerID + ".loader"
)

Variables

var (
	// ErrNilPointer defines a nil pointer argument error
	ErrNilPointer = gapp.ErrNilPointer

	// ErrConversion defines a type conversion error
	ErrConversion = gapp.ErrConversion
)

var (
	// ObserveFrequency defines the id to be used as the default of a
	// config observable source frequency time in seconds.
	ObserveFrequency = genv.Int("GAPP_CONFIG_OBSERVE_FREQUENCY", 0)

	// LoaderActive defines if the config loader should be executed
	// while the provider boot
	LoaderActive = genv.Bool("GAPP_CONFIG_LOADER_ACTIVE", true)
)

Functions

func GetConfig

func GetConfig(c gapp.ServiceContainer) (gconfig.Manager, error)

GetConfig will try to retrieve the registered config instance from the application service container.

func GetDecoderFactory

func GetDecoderFactory(c gapp.ServiceContainer) (*gconfig.DecoderFactory, error)

GetDecoderFactory will try to retrieve the registered decoder factory instance from the application service container.

func GetDecoderStrategies

func GetDecoderStrategies(c gapp.ServiceContainer) ([]gconfig.DecoderStrategy, error)

GetDecoderStrategies will try to retrieve the registered the list of decoder strategies instances from the application service container.

func GetLoader

func GetLoader(c gapp.ServiceContainer) (*gconfig.Loader, error)

GetLoader will try to retrieve the registered loader instance from the application service container.

func GetSourceFactory

func GetSourceFactory(c gapp.ServiceContainer) (*gconfig.SourceFactory, error)

GetSourceFactory will try to retrieve the registered source factory instance from the application service container.

func GetSourceStrategies

func GetSourceStrategies(c gapp.ServiceContainer) ([]gconfig.SourceStrategy, error)

GetSourceStrategies will try to retrieve the registered the list of source strategies instances from the application service container.

Types

type Provider

type Provider struct{}

Provider defines the gapp/config module service provider to be used on the application initialization to register the config service.

func (Provider) Boot

func (p Provider) Boot(c gapp.ServiceContainer) error

Boot will start the configuration config instance by calling the configuration loader with the defined provider base entry information.

func (Provider) Register

func (p Provider) Register(c gapp.ServiceContainer) error

Register will register the configuration section instances in the application container.