Package org.apache.dubbo.registry

Interface RegistryService

All Known Subinterfaces:
Registry, ServiceDiscovery
All Known Implementing Classes:
AbstractRegistry, AbstractServiceDiscovery, CacheableFailbackRegistry, FailbackRegistry, ListenerRegistryWrapper, NopServiceDiscovery, ReflectionBasedServiceDiscovery, ServiceDiscoveryRegistry
public interface RegistryService
RegistryService. (SPI, Prototype, ThreadSafe)
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    List<URL>
    lookup(URL url)
    Query the registered data that matches the conditions.
    void
    register(URL url)
    Register data, such as : provider service, consumer address, route rule, override rule and other data.
    void
    subscribe(URL url, NotifyListener listener)
    Subscribe to eligible registered data and automatically push when the registered data is changed.
    void
    unregister(URL url)
    Unregister
    void
    unsubscribe(URL url, NotifyListener listener)
    Unsubscribe

  • Method Details

    • register

      void register(URL url)
      Register data, such as : provider service, consumer address, route rule, override rule and other data.

      Registering is required to support the contract:
      1. When the URL sets the check=false parameter. When the registration fails, the exception is not thrown and retried in the background. Otherwise, the exception will be thrown.
      2. When URL sets the dynamic=false parameter, it needs to be stored persistently, otherwise, it should be deleted automatically when the registrant has an abnormal exit.
      3. When the URL sets category=routers, it means classified storage, the default category is providers, and the data can be notified by the classified section.
      4. When the registry is restarted, network jitter, data can not be lost, including automatically deleting data from the broken line.
      5. Allow URLs which have the same URL but different parameters to coexist,they can't cover each other.

      Parameters:
      url - Registration information , is not allowed to be empty, e.g: dubbo://10.20.153.10/org.apache.dubbo.foo.BarService?version=1.0.0invalid input: '&application'=kylin

    • unregister

      void unregister(URL url)
      Unregister

      Unregistering is required to support the contract:
      1. If it is the persistent stored data of dynamic=false, the registration data can not be found, then the IllegalStateException is thrown, otherwise it is ignored.
      2. Unregister according to the full url match.

      Parameters:
      url - Registration information , is not allowed to be empty, e.g: dubbo://10.20.153.10/org.apache.dubbo.foo.BarService?version=1.0.0invalid input: '&application'=kylin

    • subscribe

      void subscribe(URL url, NotifyListener listener)
      Subscribe to eligible registered data and automatically push when the registered data is changed.

      Subscribing need to support contracts:
      1. When the URL sets the check=false parameter. When the registration fails, the exception is not thrown and retried in the background.
      2. When URL sets category=routers, it only notifies the specified classification data. Multiple classifications are separated by commas, and allows asterisk to match, which indicates that all categorical data are subscribed.
      3. Allow interface, group, version, and classifier as a conditional query, e.g.: interface=org.apache.dubbo.foo.BarServiceinvalid input: '&version'=1.0.0
      4. And the query conditions allow the asterisk to be matched, subscribe to all versions of all the packets of all interfaces, e.g. :interface=*invalid input: '&group'=*invalid input: '&version'=*invalid input: '&classifier'=*
      5. When the registry is restarted and network jitter, it is necessary to automatically restore the subscription request.
      6. Allow URLs which have the same URL but different parameters to coexist,they can't cover each other.
      7. The subscription process must be blocked, when the first notice is finished and then returned.

      Parameters:
      url - Subscription condition, not allowed to be empty, e.g. consumer://10.20.153.10/org.apache.dubbo.foo.BarService?version=1.0.0invalid input: '&application'=kylin
      listener - A listener of the change event, not allowed to be empty

    • unsubscribe

      void unsubscribe(URL url, NotifyListener listener)
      Unsubscribe

      Unsubscribing is required to support the contract:
      1. If you don't subscribe, ignore it directly.
      2. Unsubscribe by full URL match.

      Parameters:
      url - Subscription condition, not allowed to be empty, e.g. consumer://10.20.153.10/org.apache.dubbo.foo.BarService?version=1.0.0invalid input: '&application'=kylin
      listener - A listener of the change event, not allowed to be empty

    • lookup

      List<URL> lookup(URL url)
      Query the registered data that matches the conditions. Corresponding to the push mode of the subscription, this is the pull mode and returns only one result.
      Parameters:
      url - Query condition, is not allowed to be empty, e.g. consumer://10.20.153.10/org.apache.dubbo.foo.BarService?version=1.0.0invalid input: '&application'=kylin
      Returns:
      The registered information list, which may be empty, the meaning is the same as the parameters of NotifyListener.notify(List<URL>).
      See Also: