config_center

package
v3.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 27, 2025 License: Apache-2.0 Imports: 13 Imported by: 26

Documentation

Overview

Package config_center provides Config Center definition and implementations for listening service governance rules.

Index

Constants

View Source 
const (
	DefaultGroup         = "dubbo"
	DefaultConfigTimeout = "10s"
)

Variables

This section is empty.

Functions

func GetRuleKey 

func GetRuleKey(url *common.URL) string

GetRuleKey The format is '{interfaceName}:[version]:[group]'

Types

type BaseDynamicConfiguration 

type BaseDynamicConfiguration struct{}

BaseDynamicConfiguration will default implementation DynamicConfiguration some method

func (*BaseDynamicConfiguration) RemoveConfig 

func (bdc *BaseDynamicConfiguration) RemoveConfig(string, string) error

type ConfigChangeEvent 

type ConfigChangeEvent struct {
	Key        string
	Value      any
	ConfigType remoting.EventType
}

ConfigChangeEvent for changing listener's event

func (ConfigChangeEvent) String 

func (c ConfigChangeEvent) String() string

type ConfigurationListener 

type ConfigurationListener interface {
	// Process the notification event once there's any change happens on the config
	Process(*ConfigChangeEvent)
}

ConfigurationListener for changing listener's event

type Configurator 

type Configurator interface {
	GetUrl() *common.URL
	Configure(url *common.URL)
}

Configurator is the interface which wraps GetUrl and Configure method.

type DynamicConfiguration 

type DynamicConfiguration interface {
	Parser() parser.ConfigurationParser
	SetParser(parser.ConfigurationParser)
	AddListener(string, ConfigurationListener, ...Option)
	RemoveListener(string, ConfigurationListener, ...Option)
	// GetProperties get properties file
	GetProperties(string, ...Option) (string, error)

	// GetRule get Router rule properties file
	GetRule(string, ...Option) (string, error)

	// GetInternalProperty get value by key in Default properties file(dubbo.properties)
	GetInternalProperty(string, ...Option) (string, error)

	// PublishConfig will publish the config with the (key, group, value) pair
	// for zk: path is /$(group)/config/$(key) -> value
	// for nacos: group, key -> value
	PublishConfig(string, string, string) error

	// RemoveConfig will remove the config white the (key, group) pair
	RemoveConfig(string, string) error

	// GetConfigKeysByGroup will return all keys with the group
	GetConfigKeysByGroup(group string) (*gxset.HashSet, error)
}

DynamicConfiguration is the interface which modifys listener and gets properties file.

type DynamicConfigurationFactory 

type DynamicConfigurationFactory interface {
	GetDynamicConfiguration(*common.URL) (DynamicConfiguration, error)
}

DynamicConfigurationFactory gets the DynamicConfiguration

type MockDynamicConfiguration 

type MockDynamicConfiguration struct {
	BaseDynamicConfiguration
	// contains filtered or unexported fields
}

MockDynamicConfiguration uses to parse content and defines listener

func (*MockDynamicConfiguration) AddListener 

func (c *MockDynamicConfiguration) AddListener(key string, listener ConfigurationListener, _ ...Option)

AddListener adds a listener for MockDynamicConfiguration

func (*MockDynamicConfiguration) GetConfig 

func (c *MockDynamicConfiguration) GetConfig(_ string, _ ...Option) (string, error)

GetConfig returns content of MockDynamicConfiguration

func (*MockDynamicConfiguration) GetConfigKeysByGroup 

func (c *MockDynamicConfiguration) GetConfigKeysByGroup(group string) (*gxset.HashSet, error)

GetConfigKeysByGroup will return all keys with the group

func (*MockDynamicConfiguration) GetConfigs 

func (c *MockDynamicConfiguration) GetConfigs(key string, opts ...Option) (string, error)

GetConfigs For zookeeper, getConfig and getConfigs have the same meaning.

func (*MockDynamicConfiguration) GetInternalProperty 

func (c *MockDynamicConfiguration) GetInternalProperty(key string, opts ...Option) (string, error)

GetInternalProperty For zookeeper, getConfig and getConfigs have the same meaning.

func (*MockDynamicConfiguration) GetProperties 

func (c *MockDynamicConfiguration) GetProperties(_ string, _ ...Option) (string, error)

GetProperties gets content of MockDynamicConfiguration

func (*MockDynamicConfiguration) GetRule 

func (c *MockDynamicConfiguration) GetRule(key string, opts ...Option) (string, error)

GetRule gets properties of MockDynamicConfiguration

func (*MockDynamicConfiguration) MockApplicationConfigEvent 

func (c *MockDynamicConfiguration) MockApplicationConfigEvent()

MockApplicationConfigEvent returns ConfiguratorConfig

func (*MockDynamicConfiguration) MockServiceConfigEvent 

func (c *MockDynamicConfiguration) MockServiceConfigEvent()

MockServiceConfigEvent returns ConfiguratorConfig

func (*MockDynamicConfiguration) Parser 

func (c *MockDynamicConfiguration) Parser() parser.ConfigurationParser

Parser returns a parser of MockDynamicConfiguration

func (*MockDynamicConfiguration) PublishConfig 

func (c *MockDynamicConfiguration) PublishConfig(string, string, string) error

PublishConfig will publish the config with the (key, group, value) pair

func (*MockDynamicConfiguration) RemoveListener 

func (c *MockDynamicConfiguration) RemoveListener(_ string, _ ConfigurationListener, _ ...Option)

RemoveListener removes the listener for MockDynamicConfiguration

func (*MockDynamicConfiguration) SetParser 

func (c *MockDynamicConfiguration) SetParser(p parser.ConfigurationParser)

SetParser sets parser of MockDynamicConfiguration

type MockDynamicConfigurationFactory 

type MockDynamicConfigurationFactory struct {
	Content             string
	ConfiguratorContent string
}

MockDynamicConfigurationFactory defines content

func (*MockDynamicConfigurationFactory) GetDynamicConfiguration 

func (f *MockDynamicConfigurationFactory) GetDynamicConfiguration(_ *common.URL) (DynamicConfiguration, error)

GetDynamicConfiguration returns a DynamicConfiguration

type Option 

type Option func(*Options)

func WithAddress added in v3.3.0 

func WithAddress(address string) Option

func WithApollo added in v3.3.1 

func WithApollo() Option

func WithAppID added in v3.3.0 

func WithAppID(id string) Option

func WithCluster added in v3.3.0 

func WithCluster(cluster string) Option

func WithConfigCenter added in v3.3.0 

func WithConfigCenter(cc string) Option

func WithDataID added in v3.3.0 

func WithDataID(id string) Option

func WithFile added in v3.3.0 

func WithFile() Option

func WithFileExtJson added in v3.3.0 

func WithFileExtJson() Option

func WithFileExtProperties added in v3.3.0 

func WithFileExtProperties() Option

func WithFileExtToml added in v3.3.0 

func WithFileExtToml() Option

func WithFileExtYaml added in v3.3.0 

func WithFileExtYaml() Option

func WithFileExtYml added in v3.3.0 

func WithFileExtYml() Option

func WithGroup 

func WithGroup(group string) Option

func WithNacos added in v3.3.0 

func WithNacos() Option

func WithNamespace added in v3.3.0 

func WithNamespace(namespace string) Option

func WithParams added in v3.3.0 

func WithParams(params map[string]string) Option

func WithPassword added in v3.3.0 

func WithPassword(password string) Option

func WithTimeout 

func WithTimeout(timeout time.Duration) Option

func WithUsername added in v3.3.0 

func WithUsername(username string) Option

func WithZookeeper added in v3.3.0 

func WithZookeeper() Option

type Options 

type Options struct {
	Center *global.CenterConfig
}

func NewOptions added in v3.3.0 

func NewOptions(opts ...Option) *Options

Source Files

View all Source files

Directories

Path Synopsis
Package apollo implements config center around Apollo.
 Package apollo implements config center around Apollo.
Package file implements config center around file system.
 Package file implements config center around file system.
Package nacos implements config center around Nacos.
 Package nacos implements config center around Nacos.
Package zookeeper implements config center around zookeeper.
 Package zookeeper implements config center around zookeeper.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.