com.alibaba.nacos.api.naming.NamingMaintainService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nacos-api Show documentation
Nacos api pom.xml file
There is a newer version: 2.4.3
/*
 * Copyright 1999-2018 Alibaba Group Holding Ltd.
 *
 * Licensed 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.api.naming;

import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.api.naming.pojo.Instance;
import com.alibaba.nacos.api.naming.pojo.Service;
import com.alibaba.nacos.api.selector.AbstractSelector;

import java.util.Map;

/**
 * Operations related to Nacos.
 *
 * @author liaochuntao
 * @since 1.0.1
 */
public interface NamingMaintainService {
    
    /**
     * update instance info.
     *
     * @param serviceName service name
     * @param instance    instance
     * @throws NacosException nacos exception
     */
    void updateInstance(String serviceName, Instance instance) throws NacosException;
    
    /**
     * update instance info.
     *
     * @param serviceName service name
     * @param groupName   group name
     * @param instance    instance
     * @throws NacosException nacos exception
     */
    void updateInstance(String serviceName, String groupName, Instance instance) throws NacosException;
    
    /**
     * query service.
     *
     * @param serviceName service name
     * @return service
     * @throws NacosException nacos exception
     */
    Service queryService(String serviceName) throws NacosException;
    
    /**
     * query service.
     *
     * @param serviceName service name
     * @param groupName   group name
     * @return service
     * @throws NacosException nacos exception
     */
    Service queryService(String serviceName, String groupName) throws NacosException;
    
    /**
     * create service to Nacos.
     *
     * @param serviceName name of service
     * @throws NacosException nacos exception
     */
    void createService(String serviceName) throws NacosException;
    
    /**
     * create service to Nacos.
     *
     * @param serviceName name of service
     * @param groupName   group of service
     * @throws NacosException nacos exception
     */
    void createService(String serviceName, String groupName) throws NacosException;
    
    /**
     * create service to Nacos.
     *
     * @param serviceName      name of service
     * @param groupName        group of service
     * @param protectThreshold protectThreshold of service
     * @throws NacosException nacos exception
     */
    void createService(String serviceName, String groupName, float protectThreshold) throws NacosException;
    
    /**
     * create service to Nacos.
     *
     * @param serviceName      name of service
     * @param groupName        group of service
     * @param protectThreshold protectThreshold of service
     * @param expression       expression of selector
     * @throws NacosException nacos exception
     */
    void createService(String serviceName, String groupName, float protectThreshold, String expression)
            throws NacosException;
    
    /**
     * create service to Nacos.
     *
     * @param service  name of service
     * @param selector selector
     * @throws NacosException nacos exception
     */
    void createService(Service service, AbstractSelector selector) throws NacosException;
    
    /**
     * delete service from Nacos.
     *
     * @param serviceName name of service
     * @return if delete service success return true
     * @throws NacosException nacos exception
     */
    boolean deleteService(String serviceName) throws NacosException;
    
    /**
     * delete service from Nacos.
     *
     * @param serviceName name of service
     * @param groupName   group of service
     * @return if delete service success return true
     * @throws NacosException nacos exception
     */
    boolean deleteService(String serviceName, String groupName) throws NacosException;
    
    /**
     * update service to Nacos.
     *
     * @param serviceName      name of service
     * @param groupName        group of service
     * @param protectThreshold protectThreshold of service
     * @throws NacosException nacos exception
     */
    void updateService(String serviceName, String groupName, float protectThreshold) throws NacosException;
    
    /**
     * update service to Nacos.
     *
     * @param serviceName      name of service
     * @param groupName        group of service
     * @param protectThreshold protectThreshold of service
     * @param metadata         metadata of service
     * @throws NacosException nacos exception
     */
    void updateService(String serviceName, String groupName, float protectThreshold, Map metadata)
            throws NacosException;
    
    /**
     * update service to Nacos with selector.
     *
     * @param service  {@link Service} pojo of service
     * @param selector {@link AbstractSelector} pojo of selector
     * @throws NacosException nacos exception
     */
    void updateService(Service service, AbstractSelector selector) throws NacosException;
    
    /**
     * Shutdown the resource service.
     *
     * @throws NacosException exception.
     */
    void shutDown() throws NacosException;
}