DynamicConfiguration (Apache Dubbo 2.7.22 API)

所有超级接口:

AutoCloseable, Configuration

所有已知实现类:

AbstractDynamicConfiguration, CompositeDynamicConfiguration, FileSystemDynamicConfiguration, NopDynamicConfiguration, TreePathDynamicConfiguration
```
public interface DynamicConfiguration
extends Configuration, AutoCloseable
```
Dynamic Configuration
From the use scenario internally inside framework, there're mainly three kinds of methods:
1. getProperties(String, String, long), get configuration file from Config Center at start up.
2. addListener(String, String, ConfigurationListener)/ removeListener(String, String, ConfigurationListener) , add or remove listeners for governance rules or config items that need to watch.
3. Configuration.getProperty(String, Object), get a single config item.
4. getConfig(String, String, long), get the specified config
另请参阅:

AbstractDynamicConfiguration

字段概要

字段
限定符和类型字段和说明

static String DEFAULT_GROUP

字段
限定符和类型	字段和说明
`static String`	`DEFAULT_GROUP`

方法概要

所有方法静态方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`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.
`default void`	`close()` Close the configuration
`default String`	`getConfig(String key, String group)` Get the configuration mapped to the given key and the given group with `the default timeout`
`String`	`getConfig(String key, String group, long timeout)` Get the configuration mapped to the given key and the given group.
`default SortedSet<String>`	`getConfigKeys(String group)` Get the config keys by the specified group
`default String`	`getDefaultGroup()` Get the default group for the operations
`default long`	`getDefaultTimeout()` Get the default timeout for the operations in milliseconds
`static DynamicConfiguration`	`getDynamicConfiguration()` Find DynamicConfiguration instance
`static DynamicConfiguration`	`getDynamicConfiguration(URL connectionURL)` Get the instance of `DynamicConfiguration` by the specified connection `URL`
`default String`	`getProperties(String key, String group)` This method are mostly used to get a compound config file with `the default timeout`, such as a complete dubbo.properties file.
`default 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.
`static String`	`getRuleKey(URL url)` The format is '{interfaceName}:[version]:[group]'
`default boolean`	`publishConfig(String key, String content)` Publish Config mapped to the given key under the `default group`
`default boolean`	`publishConfig(String key, String group, String content)` Publish Config mapped to the given key and the given group.
`default boolean`	`removeConfig(String key, String 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.

从接口继承的方法 org.apache.dubbo.common.config.Configuration
containsKey, convert, getBoolean, getBoolean, getBoolean, getInt, getInt, getInteger, getInternalProperty, getProperty, getProperty, getString, getString, toBooleanObject

- 字段详细资料
  - DEFAULT_GROUP
```
static final String DEFAULT_GROUP
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - addListener
```
default void addListener(String key,
                         ConfigurationListener listener)
```
    addListener(String, String, ConfigurationListener)
    
    参数:
    
    key - the key to represent a configuration
    
    listener - configuration listener
  - removeListener
```
default void removeListener(String key,
                            ConfigurationListener listener)
```
    removeListener(String, String, ConfigurationListener)
    
    参数:
    
    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.
    
    参数:
    
    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.
    
    参数:
    
    key - the key to represent a configuration
    
    group - the group where the key belongs to
    
    listener - configuration listener
  - getConfig
```
default String getConfig(String key,
                         String group)
```
    Get the configuration mapped to the given key and the given group with the default timeout
    
    参数:
    
    key - the key to represent a configuration
    
    group - the group where the key belongs to
    
    返回:
    
    target configuration mapped to the given key and the given group
  - getConfig
```
String getConfig(String key,
                 String group,
                 long timeout)
          throws IllegalStateException
```
    Get the configuration mapped to the given key and the given group. If the configuration fails to fetch after timeout exceeds, IllegalStateException will be thrown.
    
    参数:
    
    key - the key to represent a configuration
    
    group - the group where the key belongs to
    
    timeout - timeout value for fetching the target config
    
    返回:
    
    target configuration mapped to the given key and the given group, IllegalStateException will be thrown if timeout exceeds.
    
    抛出:
    
    IllegalStateException
  - getProperties
```
default String getProperties(String key,
                             String group)
                      throws IllegalStateException
```
    This method are mostly used to get a compound config file with the default timeout, such as a complete dubbo.properties file.
    
    抛出:
    
    IllegalStateException
  - getProperties
```
default 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.
    
    抛出:
    
    IllegalStateException
  - publishConfig
```
default boolean publishConfig(String key,
                              String content)
                       throws UnsupportedOperationException
```
    Publish Config mapped to the given key under the default group
    
    参数:
    
    key - the key to represent a configuration
    
    content - the content of configuration
    
    返回:
    
    true if success, or false
    
    抛出:
    
    UnsupportedOperationException - If the under layer does not support
    
    从以下版本开始:
    
    2.7.5
  - publishConfig
```
default boolean publishConfig(String key,
                              String group,
                              String content)
                       throws UnsupportedOperationException
```
    Publish Config mapped to the given key and the given group.
    
    参数:
    
    key - the key to represent a configuration
    
    group - the group where the key belongs to
    
    content - the content of configuration
    
    返回:
    
    true if success, or false
    
    抛出:
    
    UnsupportedOperationException - If the under layer does not support
    
    从以下版本开始:
    
    2.7.5
  - getConfigKeys
```
default SortedSet<String> getConfigKeys(String group)
                                 throws UnsupportedOperationException
```
    Get the config keys by the specified group
    
    参数:
    
    group - the specified group
    
    返回:
    
    the read-only non-null sorted set of config keys
    
    抛出:
    
    UnsupportedOperationException - If the under layer does not support
    
    从以下版本开始:
    
    2.7.5
  - getDefaultGroup
```
default String getDefaultGroup()
```
    Get the default group for the operations
    
    返回:
    
    The default value is "dubbo"
    
    从以下版本开始:
    
    2.7.5
  - getDefaultTimeout
```
default long getDefaultTimeout()
```
    Get the default timeout for the operations in milliseconds
    
    返回:
    
    The default value is -1L
    
    从以下版本开始:
    
    2.7.5
  - close
```
default void close()
            throws Exception
```
    Close the configuration
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    Exception
    
    从以下版本开始:
    
    2.7.5
  - getDynamicConfiguration
```
static DynamicConfiguration getDynamicConfiguration()
```
    Find DynamicConfiguration instance
    
    返回:
    
    DynamicConfiguration instance
  - getDynamicConfiguration
```
static DynamicConfiguration getDynamicConfiguration(URL connectionURL)
```
    Get the instance of DynamicConfiguration by the specified connection URL
    
    参数:
    
    connectionURL -
    
    返回:
    
    non-null
    
    从以下版本开始:
    
    2.7.5
  - getRuleKey
```
static String getRuleKey(URL url)
```
    The format is '{interfaceName}:[version]:[group]'
    
    返回:
  - removeConfig
```
default boolean removeConfig(String key,
                             String group)
```
    参数:
    
    key - the key to represent a configuration
    
    group - the group where the key belongs to
    
    返回:
    
    true if success, or false
    
    从以下版本开始:
    
    2.7.8

接口 DynamicConfiguration

字段概要

方法概要

从接口继承的方法 org.apache.dubbo.common.config.Configuration

字段详细资料

DEFAULT_GROUP

方法详细资料

addListener

removeListener

addListener

removeListener

getConfig

getConfig

getProperties

getProperties

publishConfig

publishConfig

getConfigKeys

getDefaultGroup

getDefaultTimeout

close

getDynamicConfiguration

getDynamicConfiguration

getRuleKey

removeConfig