org.apache.dubbo.registry.zookeeper

类 ZookeeperServiceDiscovery

java.lang.Object

org.apache.dubbo.registry.zookeeper.ZookeeperServiceDiscovery

所有已实现的接口:

Comparable<Prioritized>, EventListener, Prioritized, ServiceDiscovery

public class ZookeeperServiceDiscovery
extends Object
implements ServiceDiscovery, EventListener<ServiceInstancesChangedEvent>

Zookeeper ServiceDiscovery implementation based on Apache Curator X Discovery

字段概要

从接口继承的字段 org.apache.dubbo.common.lang.Prioritized

COMPARATOR, MAX_PRIORITY, MIN_PRIORITY, NORMAL_PRIORITY

构造器概要

构造器

构造器和说明
ZookeeperServiceDiscovery()

方法概要

限定符和类型	方法和说明
void	addServiceInstancesChangedListener(ServiceInstancesChangedListener listener) Add an instance of ServiceInstancesChangedListener for specified service Default, Current method will be invoked by the ServiceDiscoveryRegistry on the subscription, and it's mandatory to add the ServiceInstancesChangedListener argument into EventDispatcher whether the subclass implements same approach or not, thus this method is used to trigger or adapt the vendor's change notification mechanism typically, like Zookeeper Watcher, Nacos EventListener.
void	destroy() Destroy the ServiceDiscovery
List<ServiceInstance>	getInstances(String serviceName) Gets all service instances by the specified service name.
Page<ServiceInstance>	getInstances(String serviceName, int offset, int pageSize, boolean healthyOnly) Get the pagination of service instances by the specified service name.
Set<String>	getServices() Gets all service names
void	initialize(URL registryURL) Initializes the ServiceDiscovery
void	onEvent(ServiceInstancesChangedEvent event) Handle a Dubbo Event when it's be published
void	register(ServiceInstance serviceInstance) Registers an instance of ServiceInstance.
void	unregister(ServiceInstance serviceInstance) Unregisters an instance of ServiceInstance.
void	update(ServiceInstance serviceInstance) Updates the registered ServiceInstance.

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.apache.dubbo.registry.client.ServiceDiscovery

dispatchServiceInstancesChangedEvent, dispatchServiceInstancesChangedEvent, dispatchServiceInstancesChangedEvent, dispatchServiceInstancesChangedEvent, getDefaultPageSize, getInstances, getInstances, toString

从接口继承的方法 org.apache.dubbo.event.EventListener

findEventType, findEventType, findEventType, getPriority

从接口继承的方法 org.apache.dubbo.common.lang.Prioritized

compareTo

构造器详细资料

ZookeeperServiceDiscovery

public ZookeeperServiceDiscovery()

方法详细资料

initialize

public void initialize(URL registryURL)
                throws Exception

从接口复制的说明: ServiceDiscovery

Initializes the ServiceDiscovery

指定者:

initialize 在接口中 ServiceDiscovery

参数:

registryURL - the url to connect service registry

抛出:

Exception - If met with error

destroy

public void destroy()
             throws Exception

从接口复制的说明: ServiceDiscovery

Destroy the ServiceDiscovery

指定者:

destroy 在接口中 ServiceDiscovery

抛出:

Exception - If met with error

register

public void register(ServiceInstance serviceInstance)
              throws RuntimeException

从接口复制的说明: ServiceDiscovery

Registers an instance of ServiceInstance.

指定者:

register 在接口中 ServiceDiscovery

参数:

serviceInstance - an instance of ServiceInstance to be registered

抛出:

RuntimeException - if failed

update

public void update(ServiceInstance serviceInstance)
            throws RuntimeException

从接口复制的说明: ServiceDiscovery

Updates the registered ServiceInstance.

指定者:

update 在接口中 ServiceDiscovery

参数:

serviceInstance - the registered ServiceInstance

抛出:

RuntimeException - if failed

unregister

public void unregister(ServiceInstance serviceInstance)
                throws RuntimeException

从接口复制的说明: ServiceDiscovery

Unregisters an instance of ServiceInstance.

指定者:

unregister 在接口中 ServiceDiscovery

参数:

serviceInstance - an instance of ServiceInstance to be deregistered

抛出:

RuntimeException - if failed

getServices

public Set<String> getServices()

从接口复制的说明: ServiceDiscovery

Gets all service names

指定者:

getServices 在接口中 ServiceDiscovery

返回:

non-null read-only Set

getInstances

public List<ServiceInstance> getInstances(String serviceName)
                                   throws NullPointerException

从接口复制的说明: ServiceDiscovery

Gets all service instances by the specified service name.

指定者:

getInstances 在接口中 ServiceDiscovery

参数:

serviceName - the service name

返回:

non-null List

抛出:

NullPointerException - if serviceName is null is null

getInstances

public Page<ServiceInstance> getInstances(String serviceName,
                                          int offset,
                                          int pageSize,
                                          boolean healthyOnly)

从接口复制的说明: ServiceDiscovery

Get the pagination of service instances by the specified service name. If healthyOnly == true, filter healthy instances only.

指定者:

getInstances 在接口中 ServiceDiscovery

参数:

serviceName - the service name

offset - the offset of request , the number "0" indicates first page

pageSize - the number of request, the max value indicates the range is unlimited

healthyOnly - if true , filter healthy instances only

返回:

non-null Page object

addServiceInstancesChangedListener

public void addServiceInstancesChangedListener(ServiceInstancesChangedListener listener)
                                        throws NullPointerException,
                                               IllegalArgumentException

从接口复制的说明: ServiceDiscovery

Add an instance of ServiceInstancesChangedListener for specified service

Default, Current method will be invoked by the ServiceDiscoveryRegistry on the subscription, and it's mandatory to add the ServiceInstancesChangedListener argument into EventDispatcher whether the subclass implements same approach or not, thus this method is used to trigger or adapt the vendor's change notification mechanism typically, like Zookeeper Watcher, Nacos EventListener. If the registry observes the change, It's suggested that the implementation could invoke ServiceDiscovery.dispatchServiceInstancesChangedEvent(String) method or variants

指定者:

addServiceInstancesChangedListener 在接口中 ServiceDiscovery

参数:

listener - an instance of ServiceInstancesChangedListener

抛出:

NullPointerException

IllegalArgumentException

另请参阅:

EventPublishingServiceDiscovery, EventDispatcher

onEvent

public void onEvent(ServiceInstancesChangedEvent event)

从接口复制的说明: EventListener

Handle a Dubbo Event when it's be published

参数:

event - a Dubbo Event