config/interfaces/config_load_processor.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 interfaces

import (
	"sync"
)

import (
	"github.com/apache/dubbo-go/common"
)

// ConfigLoadProcessor is an extension to give users a chance to customize configs against ReferenceConfig and
// ServiceConfig during deployment time.
type ConfigLoadProcessor interface {
	// LoadProcessReferenceConfig customizes ReferenceConfig's params.
	// LoadProcessReferenceConfig emits on refer reference (event: before-reference-connect, reference-connect-success, reference-connect-fail)
	LoadProcessReferenceConfig(url *common.URL, event string, errMsg *string)

	// LoadProcessServiceConfig customizes ServiceConfig's params.
	// LoadProcessServiceConfig emits on export service (event: before-service-listen, service-listen-success, service-listen-fail)
	LoadProcessServiceConfig(url *common.URL, event string, errMsg *string)

	// AfterAllReferencesConnectComplete emits on all references export complete
	AfterAllReferencesConnectComplete(urls ConfigLoadProcessorURLBinder)

	// AfterAllServicesListenComplete emits on all services export complete
	AfterAllServicesListenComplete(urls ConfigLoadProcessorURLBinder)

	// BeforeShutdown emits on before shutdown
	BeforeShutdown()
}

type ConfigLoadProcessorHolder struct {
	sync.Mutex
}

type ConfigLoadProcessorURLBinder struct {
	Success []*common.URL
	Fail    []*common.URL
}