org.apache.dubbo.configcenter.support.etcd

Class EtcdDynamicConfiguration

java.lang.Object

org.apache.dubbo.configcenter.support.etcd.EtcdDynamicConfiguration

All Implemented Interfaces:

Configuration, DynamicConfiguration

public class EtcdDynamicConfiguration
extends Object
implements DynamicConfiguration

The etcd implementation of DynamicConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EtcdDynamicConfiguration.EtcdConfigWatcher

Field Summary

Fields inherited from interface org.apache.dubbo.configcenter.DynamicConfiguration

DEFAULT_GROUP

Method Summary

Modifier and Type	Method and Description
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.
Object	getInternalProperty(String key)
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.
String	getRule(String key, String group, long timeout) Get the governance rule mapped to the given key and the given group.
void	removeListener(String key, String group, ConfigurationListener listener) Stops one listener from listening to value changes in the specified key.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.dubbo.configcenter.DynamicConfiguration

addListener, getDynamicConfiguration, getProperties, getRule, getRuleKey, removeListener

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

containsKey, convert, getProperty, getProperty, getString, getString

Method Detail

addListener

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

Description copied from interface: DynamicConfiguration

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.

Specified by:

addListener in interface DynamicConfiguration

Parameters:

key - the key to represent a configuration

group - the group where the key belongs to

listener - configuration listener

removeListener

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

Description copied from interface: DynamicConfiguration

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

Specified by:

removeListener in interface DynamicConfiguration

Parameters:

key - the key to represent a configuration

group - the group where the key belongs to

listener - configuration listener

getRule

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

Description copied from interface: DynamicConfiguration

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.

Specified by:

getRule in interface DynamicConfiguration

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

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

Description copied from interface: DynamicConfiguration

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

Specified by:

getProperties in interface DynamicConfiguration

Throws:

IllegalStateException

getInternalProperty

public Object getInternalProperty(String key)

Specified by:

getInternalProperty in interface Configuration