global/registry_config.go

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package global

// todo(DMwangnima): finish refactoring and move related logic from config package to this file.
// This RegistryConfig is a copy of /config/RegistryConfig right now.
// Please refer to issue(https://github.com/apache/dubbo-go/issues/2377).

// RegistryConfig is the configuration of the registry center
type RegistryConfig struct {
	Protocol          string            `validate:"required" yaml:"protocol"  json:"protocol,omitempty" property:"protocol"`
	Timeout           string            `default:"5s" validate:"required" yaml:"timeout" json:"timeout,omitempty" property:"timeout"` // unit: second
	Group             string            `yaml:"group" json:"group,omitempty" property:"group"`
	Namespace         string            `yaml:"namespace" json:"namespace,omitempty" property:"namespace"`
	TTL               string            `default:"15m" yaml:"ttl" json:"ttl,omitempty" property:"ttl"` // unit: minute
	Address           string            `validate:"required" yaml:"address" json:"address,omitempty" property:"address"`
	Username          string            `yaml:"username" json:"username,omitempty" property:"username"`
	Password          string            `yaml:"password" json:"password,omitempty"  property:"password"`
	Simplified        bool              `yaml:"simplified" json:"simplified,omitempty"  property:"simplified"`
	Preferred         bool              `yaml:"preferred" json:"preferred,omitempty" property:"preferred"` // Always use this registry first if set to true, useful when subscribe to multiple registriesConfig
	Zone              string            `yaml:"zone" json:"zone,omitempty" property:"zone"`                // The region where the registry belongs, usually used to isolate traffics
	Weight            int64             `yaml:"weight" json:"weight,omitempty" property:"weight"`          // Affects traffic distribution among registriesConfig, useful when subscribe to multiple registriesConfig Take effect only when no preferred registry is specified.
	Params            map[string]string `yaml:"params" json:"params,omitempty" property:"params"`
	RegistryType      string            `yaml:"registry-type"`
	UseAsMetaReport   bool              `default:"true" yaml:"use-as-meta-report" json:"use-as-meta-report,omitempty" property:"use-as-meta-report"`
	UseAsConfigCenter bool              `default:"true" yaml:"use-as-config-center" json:"use-as-config-center,omitempty" property:"use-as-config-center"`
}

func DefaultRegistryConfig() *RegistryConfig {
	return &RegistryConfig{}
}

type RegistryOption func(*RegistryConfig)

func WithRegistry_Protocol(protocol string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Protocol = protocol
	}
}

func WithRegistry_Timeout(timeout string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Timeout = timeout
	}
}

func WithRegistry_Group(group string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Group = group
	}
}

func WithRegistry_Namespace(namespace string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Namespace = namespace
	}
}

func WithRegistry_TTL(ttl string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.TTL = ttl
	}
}

func WithRegistry_Address(address string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Address = address
	}
}

func WithRegistry_Username(name string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Username = name
	}
}

func WithRegistry_Password(password string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Password = password
	}
}

func WithRegistry_Simplified(flag bool) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Simplified = flag
	}
}

func WithRegistry_Preferred(flag bool) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Preferred = flag
	}
}

func WithRegistry_Zone(zone string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Zone = zone
	}
}

func WithRegistry_Weight(weight int64) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Weight = weight
	}
}

func WithRegistry_Params(params map[string]string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.Params = params
	}
}

func WithRegistry_RegistryType(typ string) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.RegistryType = typ
	}
}

func WithRegistry_UseAsMetaReport(flag bool) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.UseAsMetaReport = flag
	}
}

func WithRegistry_UseAsConfigCenter(flag bool) RegistryOption {
	return func(cfg *RegistryConfig) {
		cfg.UseAsConfigCenter = flag
	}
}