org.apache.dubbo.metadata

Interface MetadataService

public interface MetadataService

This service is used to expose the metadata information inside a Dubbo process. Typical uses include: 1. The Consumer queries the metadata information of the Provider to list the interfaces and each interface's configuration 2. The Console (dubbo-admin) queries for the metadata of a specific process, or aggregate data of all processes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_SERVICE_INTERFACES The value of All service instances
static String	VERSION The contract version of MetadataService, the future update must make sure compatible.

Method Summary

Modifier and Type	Method and Description
default Set<org.apache.dubbo.common.URL>	getExportedServiceURLs()
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
MetadataInfo	getMetadataInfo(String revision)
List<MetadataInfo>	getMetadataInfos()
org.apache.dubbo.common.URL	getMetadataURL()
String	getServiceDefinition(String serviceKey)
default 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	isMetadataService(String interfaceName)
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
default String	version() Gets the version of MetadataService that always equals VERSION

Field Detail

ALL_SERVICE_INTERFACES

static final String ALL_SERVICE_INTERFACES

The value of All service instances

See Also:

Constant Field Values

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

getMetadataURL

org.apache.dubbo.common.URL getMetadataURL()

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()

getExportedServiceURLs

default Set<org.apache.dubbo.common.URL> getExportedServiceURLs()

getServiceDefinition

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

Interface definition.

Returns:

getServiceDefinition

String getServiceDefinition(String serviceKey)

getMetadataInfo

MetadataInfo getMetadataInfo(String revision)

getMetadataInfos

List<MetadataInfo> getMetadataInfos()

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()

isMetadataService

static boolean isMetadataService(String interfaceName)