org.apache.dubbo.configcenter.support.apollo

Class ApolloDynamicConfiguration

java.lang.Object

org.apache.dubbo.configcenter.support.apollo.ApolloDynamicConfiguration

All Implemented Interfaces:

Configuration, DynamicConfiguration

public class ApolloDynamicConfiguration
extends Object
implements DynamicConfiguration

Apollo implementation, https://github.com/ctripcorp/apollo

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ApolloDynamicConfiguration.ApolloListener

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) Since all governance rules will lay under dubbo group, this method now always uses the default dubboConfig and ignores the group parameter.
String	getInternalProperty(String key) This method will be used by Configuration to get valid value at runtime.
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)

Since all governance rules will lay under dubbo group, this method now always uses the default dubboConfig and ignores the group parameter.

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 String getInternalProperty(String key)

This method will be used by Configuration to get valid value at runtime. The group is expected to be 'app level', which can be fetched from the 'config.appnamespace' in url if necessary. But I think Apollo's inheritance feature of namespace can solve the problem .

Specified by:

getInternalProperty in interface Configuration