com.alibaba.nacos.api.naming

Interface NamingService

public interface NamingService

Author:

nkorange

Method Summary

Modifier and Type	Method and Description
void	deregisterInstance(String serviceName, String ip, int port) Deregister instance from a service
void	deregisterInstance(String serviceName, String ip, int port, String clusterName) Deregister instance with specified cluster name from a service
List<Instance>	getAllInstances(String serviceName) Get all instances of a service
List<Instance>	getAllInstances(String serviceName, List<String> clusters) Get all instances within specified clusters of a service
String	getServerStatus() Get server health status
ListView<String>	getServicesOfServer(int pageNo, int pageSize) Get all service names from server
List<ServiceInfo>	getSubscribeServices() Get all subscribed services of current client
void	registerInstance(String serviceName, Instance instance) Register a instance to service with specified instance properties
void	registerInstance(String serviceName, String ip, int port) Register a instance to service
void	registerInstance(String serviceName, String ip, int port, String clusterName) Register a instance to service with specified cluster name
List<Instance>	selectInstances(String serviceName, boolean healthy) Get qualified instances of service
List<Instance>	selectInstances(String serviceName, List<String> clusters, boolean healthy) Get qualified instances within specified clusters of service
Instance	selectOneHealthyInstance(String serviceName) Select one healthy instance of service using predefined load balance strategy
Instance	selectOneHealthyInstance(String serviceName, List<String> clusters) Select one healthy instance of service using predefined load balance strategy
void	subscribe(String serviceName, EventListener listener) Subscribe service to receive events of instances alteration
void	subscribe(String serviceName, List<String> clusters, EventListener listener) Subscribe service to receive events of instances alteration
void	unsubscribe(String serviceName, EventListener listener) Unsubscribe event listener of service
void	unsubscribe(String serviceName, List<String> clusters, EventListener listener) Unsubscribe event listener of service

Method Detail

registerInstance

void registerInstance(String serviceName,
                      String ip,
                      int port)
               throws NacosException

Register a instance to service

Parameters:

serviceName - name of service

ip - instance ip

port - instance port

Throws:

NacosException

registerInstance

void registerInstance(String serviceName,
                      String ip,
                      int port,
                      String clusterName)
               throws NacosException

Register a instance to service with specified cluster name

Parameters:

serviceName - name of service

ip - instance ip

port - instance port

clusterName - instance cluster name

Throws:

NacosException

registerInstance

void registerInstance(String serviceName,
                      Instance instance)
               throws NacosException

Register a instance to service with specified instance properties

Parameters:

serviceName - name of service

instance - instance to register

Throws:

NacosException

deregisterInstance

void deregisterInstance(String serviceName,
                        String ip,
                        int port)
                 throws NacosException

Deregister instance from a service

Parameters:

serviceName - name of service

ip - instance ip

port - instance port

Throws:

NacosException

deregisterInstance

void deregisterInstance(String serviceName,
                        String ip,
                        int port,
                        String clusterName)
                 throws NacosException

Deregister instance with specified cluster name from a service

Parameters:

serviceName - name of service

ip - instance ip

port - instance port

clusterName - instance cluster name

Throws:

NacosException

getAllInstances

List<Instance> getAllInstances(String serviceName)
                        throws NacosException

Get all instances of a service

Parameters:

serviceName - name of service

Returns:

A list of instance

Throws:

NacosException

getAllInstances

List<Instance> getAllInstances(String serviceName,
                               List<String> clusters)
                        throws NacosException

Get all instances within specified clusters of a service

Parameters:

serviceName - name of service

clusters - list of cluster

Returns:

A list of qualified instance

Throws:

NacosException

selectInstances

List<Instance> selectInstances(String serviceName,
                               boolean healthy)
                        throws NacosException

Get qualified instances of service

Parameters:

serviceName - name of service

healthy - a flag to indicate returning healthy or unhealthy instances

Returns:

A qualified list of instance

Throws:

NacosException

selectInstances

List<Instance> selectInstances(String serviceName,
                               List<String> clusters,
                               boolean healthy)
                        throws NacosException

Get qualified instances within specified clusters of service

Parameters:

serviceName - name of service

clusters - list of cluster

healthy - a flag to indicate returning healthy or unhealthy instances

Returns:

A qualified list of instance

Throws:

NacosException

selectOneHealthyInstance

Instance selectOneHealthyInstance(String serviceName)
                           throws NacosException

Select one healthy instance of service using predefined load balance strategy

Parameters:

serviceName - name of service

Returns:

qualified instance

Throws:

NacosException

selectOneHealthyInstance

Instance selectOneHealthyInstance(String serviceName,
                                  List<String> clusters)
                           throws NacosException

Select one healthy instance of service using predefined load balance strategy

Parameters:

serviceName - name of service

clusters - a list of clusters should the instance belongs to

Returns:

qualified instance

Throws:

NacosException

subscribe

void subscribe(String serviceName,
               EventListener listener)
        throws NacosException

Subscribe service to receive events of instances alteration

Parameters:

serviceName - name of service

listener - event listener

Throws:

NacosException

subscribe

void subscribe(String serviceName,
               List<String> clusters,
               EventListener listener)
        throws NacosException

Subscribe service to receive events of instances alteration

Parameters:

serviceName - name of service

clusters - list of cluster

listener - event listener

Throws:

NacosException

unsubscribe

void unsubscribe(String serviceName,
                 EventListener listener)
          throws NacosException

Unsubscribe event listener of service

Parameters:

serviceName - name of service

listener - event listener

Throws:

NacosException

unsubscribe

void unsubscribe(String serviceName,
                 List<String> clusters,
                 EventListener listener)
          throws NacosException

Unsubscribe event listener of service

Parameters:

serviceName - name of service

clusters - list of cluster

listener - event listener

Throws:

NacosException

getServicesOfServer

ListView<String> getServicesOfServer(int pageNo,
                                     int pageSize)
                              throws NacosException

Get all service names from server

Parameters:

pageNo - page index

pageSize - page size

Returns:

list of service names

Throws:

NacosException

getSubscribeServices

List<ServiceInfo> getSubscribeServices()
                                throws NacosException

Get all subscribed services of current client

Returns:

subscribed services

Throws:

NacosException

getServerStatus

String getServerStatus()

Get server health status

Returns:

is server healthy