remote_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 config

import (
	"net/url"
	"time"
)

import (
	perrors "github.com/pkg/errors"
)

import (
	"dubbo.apache.org/dubbo-go/v3/common"
	"dubbo.apache.org/dubbo-go/v3/common/constant"
)

// RemoteConfig usually we need some middleware, including nacos, zookeeper
// this represents an instance of this middleware
// so that other module, like config center, registry could reuse the config
// but now, only metadata report, metadata service, service discovery use this structure
type RemoteConfig struct {
	Protocol string            `yaml:"protocol"  json:"protocol,omitempty" property:"protocol"`
	Address  string            `yaml:"address" json:"address,omitempty" property:"address"`
	Timeout  string            `default:"5s" yaml:"timeout" json:"timeout,omitempty" property:"timeout"`
	Username string            `yaml:"username" json:"username,omitempty" property:"username"`
	Password string            `yaml:"password" json:"password,omitempty"  property:"password"`
	Params   map[string]string `yaml:"params" json:"params,omitempty"`
}

// Prefix dubbo.remote.
func (rc *RemoteConfig) Prefix() string {
	return constant.RemotePrefix
}

func (rc *RemoteConfig) Init() error {
	return nil
}

// GetTimeout return timeout duration.
// if the configure is invalid, or missing, the default value 5s will be returned
func (rc *RemoteConfig) GetTimeout() time.Duration {
	if res, err := time.ParseDuration(rc.Timeout); err == nil {
		return res
	}
	return 5 * time.Second
}

// GetParam will return the value of the key. If not found, def will be return;
// def => default value
func (rc *RemoteConfig) GetParam(key string, def string) string {
	param, ok := rc.Params[key]
	if !ok {
		return def
	}
	return param
}

// ToURL config to url
func (rc *RemoteConfig) ToURL() (*common.URL, error) {
	if len(rc.Protocol) == 0 {
		return nil, perrors.Errorf("Must provide protocol in RemoteConfig.")
	}
	return common.NewURL(rc.Address,
		common.WithProtocol(rc.Protocol),
		common.WithUsername(rc.Username),
		common.WithPassword(rc.Password),
		common.WithLocation(rc.Address),
		common.WithParams(rc.getUrlMap()),
	)
}

// getUrlMap get url map
func (rc *RemoteConfig) getUrlMap() url.Values {
	urlMap := url.Values{}
	urlMap.Set(constant.ConfigUsernameKey, rc.Username)
	urlMap.Set(constant.ConfigPasswordKey, rc.Password)
	urlMap.Set(constant.ConfigTimeoutKey, rc.Timeout)
	urlMap.Set(constant.ClientNameKey, clientNameID(rc, rc.Protocol, rc.Protocol))

	for key, val := range rc.Params {
		urlMap.Set(key, val)
	}
	return urlMap
}

func NewRemoteConfigBuilder() *RemoteConfigBuilder {
	return &RemoteConfigBuilder{remoteConfig: &RemoteConfig{}}
}

type RemoteConfigBuilder struct {
	remoteConfig *RemoteConfig
}

func (rcb *RemoteConfigBuilder) SetProtocol(protocol string) *RemoteConfigBuilder {
	rcb.remoteConfig.Protocol = protocol
	return rcb
}

func (rcb *RemoteConfigBuilder) SetAddress(address string) *RemoteConfigBuilder {
	rcb.remoteConfig.Address = address
	return rcb
}

func (rcb *RemoteConfigBuilder) SetTimeout(timeout string) *RemoteConfigBuilder {
	rcb.remoteConfig.Timeout = timeout
	return rcb
}

func (rcb *RemoteConfigBuilder) SetUsername(username string) *RemoteConfigBuilder {
	rcb.remoteConfig.Username = username
	return rcb
}

func (rcb *RemoteConfigBuilder) SetPassword(password string) *RemoteConfigBuilder {
	rcb.remoteConfig.Password = password
	return rcb
}

func (rcb *RemoteConfigBuilder) SetParams(params map[string]string) *RemoteConfigBuilder {
	rcb.remoteConfig.Params = params
	return rcb
}

func (rcb *RemoteConfigBuilder) AddParam(key, value string) *RemoteConfigBuilder {
	if rcb.remoteConfig.Params == nil {
		rcb.remoteConfig.Params = make(map[string]string)
	}
	rcb.remoteConfig.Params[key] = value
	return rcb
}

func (rcb *RemoteConfigBuilder) Build() *RemoteConfig {
	if err := rcb.remoteConfig.Init(); err != nil {
		panic(err)
	}
	return rcb.remoteConfig
}