org.apache.dubbo.configcenter

Interface DynamicConfiguration

All Superinterfaces:

Configuration

All Known Implementing Classes:

ApolloDynamicConfiguration, ConsulDynamicConfiguration, EtcdDynamicConfiguration, NacosDynamicConfiguration, NopDynamicConfiguration, ZookeeperDynamicConfiguration

public interface DynamicConfiguration
extends Configuration

Dynamic Configuration
From the use scenario internally in framework, there're mainly three kinds of methods:

• 1. getConfig, get governance rules or single config item from Config Center.
• 2. getConfigFile, get configuration file from Config Center at start up.
• 3. addListener/removeListener, add or remove listeners for governance rules or config items that need to watch.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_GROUP

Method Summary

Modifier and Type	Method and Description
default void	addListener(String key, ConfigurationListener listener) addListener(String, String, ConfigurationListener)
void	addListener(String key, String group, ConfigurationListener listener) Register a configuration listener for a specified key The listener only works for service governance purpose, so the target group would always be the value user specifies at startup or 'dubbo' by default.
static DynamicConfiguration	getDynamicConfiguration() Find DynamicConfiguration instance
default String	getProperties(String key, String group) This method are mostly used to get a compound config file, such as a complete dubbo.properties file.
String	getProperties(String key, String group, long timeout) This method are mostly used to get a compound config file, such as a complete dubbo.properties file.
default String	getRule(String key, String group) Get the governance rule mapped to the given key and the given group
String	getRule(String key, String group, long timeout) Get the governance rule mapped to the given key and the given group.
static String	getRuleKey(URL url) The format is '{interfaceName}:[version]:[group]'
default void	removeListener(String key, ConfigurationListener listener) removeListener(String, String, ConfigurationListener)
void	removeListener(String key, String group, ConfigurationListener listener) Stops one listener from listening to value changes in the specified key.

Methods inherited from interface org.apache.dubbo.common.config.Configuration

containsKey, convert, getInternalProperty, getProperty, getProperty, getString, getString

Field Detail

DEFAULT_GROUP

static final String DEFAULT_GROUP

See Also:

Constant Field Values

Method Detail

addListener

default void addListener(String key,
                         ConfigurationListener listener)

addListener(String, String, ConfigurationListener)

Parameters:

key - the key to represent a configuration

listener - configuration listener

removeListener

default void removeListener(String key,
                            ConfigurationListener listener)

removeListener(String, String, ConfigurationListener)

Parameters:

key - the key to represent a configuration

listener - configuration listener

addListener

void addListener(String key,
                 String group,
                 ConfigurationListener listener)

Register a configuration listener for a specified key The listener only works for service governance purpose, so the target group would always be the value user specifies at startup or 'dubbo' by default. This method will only register listener, which means it will not trigger a notification that contains the current value.

Parameters:

key - the key to represent a configuration

group - the group where the key belongs to

listener - configuration listener

removeListener

void removeListener(String key,
                    String group,
                    ConfigurationListener listener)

Stops one listener from listening to value changes in the specified key.

Parameters:

key - the key to represent a configuration

group - the group where the key belongs to

listener - configuration listener

getRule

default String getRule(String key,
                       String group)

Get the governance rule mapped to the given key and the given group

Parameters:

key - the key to represent a configuration

group - the group where the key belongs to

Returns:

target configuration mapped to the given key and the given group

getRule

String getRule(String key,
               String group,
               long timeout)
        throws IllegalStateException

Get the governance rule mapped to the given key and the given group. If the rule fails to return after timeout exceeds, IllegalStateException will be thrown.

Parameters:

key - the key to represent a configuration

group - the group where the key belongs to

timeout - timeout value for fetching the target config

Returns:

target configuration mapped to the given key and the given group, IllegalStateException will be thrown if timeout exceeds.

Throws:

IllegalStateException

getProperties

default String getProperties(String key,
                             String group)
                      throws IllegalStateException

This method are mostly used to get a compound config file, such as a complete dubbo.properties file. Also #getConfig(String, String)

Throws:

IllegalStateException

getProperties

String getProperties(String key,
                     String group,
                     long timeout)
              throws IllegalStateException

This method are mostly used to get a compound config file, such as a complete dubbo.properties file. Also #getConfig(String, String, long)

Throws:

IllegalStateException

getDynamicConfiguration

static DynamicConfiguration getDynamicConfiguration()

Find DynamicConfiguration instance

Returns:

DynamicConfiguration instance

getRuleKey

static String getRuleKey(URL url)

The format is '{interfaceName}:[version]:[group]'

Returns: