org.apache.dubbo.metadata

Interface MetadataService

All Known Subinterfaces:

WritableMetadataService

All Known Implementing Classes:

InMemoryWritableMetadataService, RemoteWritableMetadataService, RemoteWritableMetadataServiceDelegate

public interface MetadataService

A framework interface of Dubbo Metadata Service defines the contract of Dubbo Services registartion and subscription between Dubbo service providers and its consumers. The implementation will be exported as a normal Dubbo service that the clients would subscribe, whose version comes from the version() method and group gets from serviceName(), that means, The different Dubbo service(application) will export the different MetadataService that persists all the exported and subscribed metadata, they are present by getExportedURLs() and getSubscribedURLs() respectively. What's more, MetadataService also providers the fine-grain methods for the precise queries.

Since:

2.7.5

See Also:

WritableMetadataService

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_SERVICE_INTERFACES The value of All service instances
static String	ALL_SERVICE_NAMES The value of all service names
static String	DEFAULT_EXTENSION
static String	SERVICE_INTERFACE_NAME The service interface name of MetadataService
static String	VERSION The contract version of MetadataService, the future update must make sure compatible.

Method Summary

Modifier and Type	Method and Description
default SortedSet<String>	getExportedURLs() Get the sorted set of String that presents all Dubbo exported urls
default SortedSet<String>	getExportedURLs(String serviceInterface) Get the sorted set of String that presents the specified Dubbo exported urls by the serviceInterface
default SortedSet<String>	getExportedURLs(String serviceInterface, String group) Get the sorted set of String that presents the specified Dubbo exported urls by the serviceInterface and group
default SortedSet<String>	getExportedURLs(String serviceInterface, String group, String version) Get the sorted set of String that presents the specified Dubbo exported urls by the serviceInterface, group and version
SortedSet<String>	getExportedURLs(String serviceInterface, String group, String version, String protocol) Get the sorted set of String that presents the specified Dubbo exported urls by the serviceInterface, group, version and protocol
String	getServiceDefinition(String serviceKey) Interface definition.
String	getServiceDefinition(String interfaceName, String version, String group) Interface definition.
default SortedSet<String>	getSubscribedURLs() the list of String that presents all Dubbo subscribed urls
static boolean	isMetadataServiceURL(org.apache.dubbo.common.URL url) Is the URL for the MetadataService or not?
String	serviceName() Gets the current Dubbo Service name
static SortedSet<String>	toSortedStrings(Iterable<org.apache.dubbo.common.URL> iterable) Convert the specified Iterable of URLs to be the strings presenting the URLs
static SortedSet<String>	toSortedStrings(Stream<org.apache.dubbo.common.URL> stream) Convert the specified Stream of URLs to be the strings presenting the URLs
static List<org.apache.dubbo.common.URL>	toURLs(Iterable<String> urls) Convert the multiple urls to a list of urls
default String	version() Gets the version of MetadataService that always equals VERSION

Field Detail

DEFAULT_EXTENSION

static final String DEFAULT_EXTENSION

See Also:

Constant Field Values

ALL_SERVICE_NAMES

static final String ALL_SERVICE_NAMES

The value of all service names

See Also:

Constant Field Values

ALL_SERVICE_INTERFACES

static final String ALL_SERVICE_INTERFACES

The value of All service instances

See Also:

Constant Field Values

SERVICE_INTERFACE_NAME

static final String SERVICE_INTERFACE_NAME

The service interface name of MetadataService

VERSION

static final String VERSION

The contract version of MetadataService, the future update must make sure compatible.

See Also:

Constant Field Values

Method Detail

serviceName

String serviceName()

Gets the current Dubbo Service name

Returns:

non-null

version

default String version()

Gets the version of MetadataService that always equals VERSION

Returns:

non-null

See Also:

VERSION

getSubscribedURLs

default SortedSet<String> getSubscribedURLs()

the list of String that presents all Dubbo subscribed urls

Returns:

the non-null read-only sorted set of strings presenting the URLs

See Also:

toSortedStrings(Stream), URL.toFullString()

getExportedURLs

default SortedSet<String> getExportedURLs()

Get the sorted set of String that presents all Dubbo exported urls

Returns:

the non-null read-only sorted set of strings presenting the URLs

See Also:

toSortedStrings(Stream), URL.toFullString()

getExportedURLs

default SortedSet<String> getExportedURLs(String serviceInterface)

Get the sorted set of String that presents the specified Dubbo exported urls by the serviceInterface

Parameters:

serviceInterface - The class name of Dubbo service interface

Returns:

the non-null read-only sorted set of strings presenting the URLs

See Also:

toSortedStrings(Stream), URL.toFullString()

getExportedURLs

default SortedSet<String> getExportedURLs(String serviceInterface,
                                          String group)

Get the sorted set of String that presents the specified Dubbo exported urls by the serviceInterface and group

Parameters:

serviceInterface - The class name of Dubbo service interface

group - the Dubbo Service Group (optional)

Returns:

the non-null read-only sorted set of strings presenting the URLs

See Also:

toSortedStrings(Stream), URL.toFullString()

getExportedURLs

default SortedSet<String> getExportedURLs(String serviceInterface,
                                          String group,
                                          String version)

Get the sorted set of String that presents the specified Dubbo exported urls by the serviceInterface, group and version

Parameters:

serviceInterface - The class name of Dubbo service interface

group - the Dubbo Service Group (optional)

version - the Dubbo Service Version (optional)

Returns:

the non-null read-only sorted set of strings presenting the URLs

See Also:

toSortedStrings(Stream), URL.toFullString()

getExportedURLs

SortedSet<String> getExportedURLs(String serviceInterface,
                                  String group,
                                  String version,
                                  String protocol)

Get the sorted set of String that presents the specified Dubbo exported urls by the serviceInterface, group, version and protocol

Parameters:

serviceInterface - The class name of Dubbo service interface

group - the Dubbo Service Group (optional)

version - the Dubbo Service Version (optional)

protocol - the Dubbo Service Protocol (optional)

Returns:

the non-null read-only sorted set of strings presenting the URLs

See Also:

toSortedStrings(Stream), URL.toFullString()

getServiceDefinition

String getServiceDefinition(String interfaceName,
                            String version,
                            String group)

Interface definition.

Returns:

getServiceDefinition

String getServiceDefinition(String serviceKey)

Interface definition.

Returns:

isMetadataServiceURL

static boolean isMetadataServiceURL(org.apache.dubbo.common.URL url)

Is the URL for the MetadataService or not?

Parameters:

url - url

Returns:

toURLs

static List<org.apache.dubbo.common.URL> toURLs(Iterable<String> urls)

Convert the multiple urls to a list of urls

Parameters:

urls - the strings presents the Dubbo URLs

Returns:

non-null

toSortedStrings

static SortedSet<String> toSortedStrings(Iterable<org.apache.dubbo.common.URL> iterable)

Convert the specified Iterable of URLs to be the strings presenting the URLs

Parameters:

iterable - Iterable of URL

Returns:

the non-null read-only sorted set of strings presenting

See Also:

URL.toFullString()

toSortedStrings

static SortedSet<String> toSortedStrings(Stream<org.apache.dubbo.common.URL> stream)

Convert the specified Stream of URLs to be the strings presenting the URLs

Parameters:

stream - Stream of URL

Returns:

the non-null read-only sorted set of strings presenting

See Also:

URL.toFullString()