com.alibaba.nacos.spring.factory.NacosServiceFactory Maven / Gradle / Ivy

Go to download
/*
 * 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 com.alibaba.nacos.spring.factory;

import java.util.Collection;
import java.util.Properties;

import com.alibaba.nacos.api.NacosFactory;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.naming.NamingMaintainService;
import com.alibaba.nacos.api.naming.NamingService;

/**
 * Nacos Service Factory
 *
 * @author Mercy
 * @see NacosFactory
 * @since 0.1.0
 */
public interface NacosServiceFactory {

	/**
	 * The bean name of {@link NacosServiceFactory}
	 */
	String BEAN_NAME = "nacosServiceFactory";

	/**
	 * Create {@link ConfigService} instance
	 *
	 * @param properties init param
	 * @return a {@link ConfigService} instance
	 * @throws NacosException If creation is failed.
	 * @see NacosFactory#createConfigService(Properties)
	 */
	ConfigService createConfigService(Properties properties) throws NacosException;

	/**
	 * Create {@link NamingService} instance
	 *
	 * @param properties init param
	 * @return a {@link NamingService} instance
	 * @throws NacosException If creation is failed.
	 * @see NacosFactory#createNamingService(Properties)
	 */
	NamingService createNamingService(Properties properties) throws NacosException;

	/**
	 * Create {@link NamingMaintainService} instance
	 *
	 * @param properties init param
	 * @return a {@link NamingMaintainService} instance
	 * @throws NacosException If creation is failed.
	 * @see NacosFactory#createNamingService(Properties)
	 */
	NamingMaintainService createNamingMaintainService(Properties properties)
			throws NacosException;

	/**
	 * Get all instances of {@link ConfigService}
	 *
	 * @return read-only {@link Collection}
	 */
	Collection getConfigServices();

	/**
	 * Get all instances of {@link NamingService}
	 *
	 * @return read-only {@link Collection}
	 */
	Collection getNamingServices();

	/**
	 * Get all instances of {@link NamingMaintainService}
	 *
	 * @return read-only {@link Collection}
	 */
	Collection getNamingMaintainService();

}