org.apache.dubbo.configcenter.consul

Class ConsulDynamicConfiguration

java.lang.Object

org.apache.dubbo.configcenter.consul.ConsulDynamicConfiguration

All Implemented Interfaces:

AutoCloseable, DynamicConfiguration, Configuration

public class ConsulDynamicConfiguration
extends Object
implements DynamicConfiguration

config center implementation for consul

Field Summary

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

DEFAULT_GROUP

Constructor Summary

Constructors

Constructor and Description
ConsulDynamicConfiguration(URL url)

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.
void	close() Close the configuration
String	getConfig(String key, String group, long timeout) Get the configuration mapped to the given key and the given group.
SortedSet<String>	getConfigKeys(String group) Get the config keys by the specified group
Object	getInternalProperty(String key)
boolean	publishConfig(String key, String group, String content) Publish Config 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.common.config.configcenter.DynamicConfiguration

addListener, getConfig, getDefaultGroup, getDefaultTimeout, getDynamicConfiguration, getDynamicConfiguration, getProperties, getProperties, getRuleKey, publishConfig, removeListener

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

containsKey, convert, getBoolean, getBoolean, getBoolean, getInt, getInt, getInteger, getProperty, getProperty, getString, getString, toBooleanObject

Constructor Detail

ConsulDynamicConfiguration

public ConsulDynamicConfiguration(URL url)

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

getConfig

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

Description copied from interface: DynamicConfiguration

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.

Specified by:

getConfig 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

getConfigKeys

public SortedSet<String> getConfigKeys(String group)
                                throws UnsupportedOperationException

Description copied from interface: DynamicConfiguration

Get the config keys by the specified group

Specified by:

getConfigKeys in interface DynamicConfiguration

Parameters:

group - the specified group

Returns:

the read-only non-null sorted set of config keys

Throws:

UnsupportedOperationException - If the under layer does not support

publishConfig

public boolean publishConfig(String key,
                             String group,
                             String content)
                      throws UnsupportedOperationException

Description copied from interface: DynamicConfiguration

Publish Config mapped to the given key and the given group.

Specified by:

publishConfig in interface DynamicConfiguration

Parameters:

key - the key to represent a configuration

group - the group where the key belongs to

content - the content of configuration

Returns:

Throws:

UnsupportedOperationException

getInternalProperty

public Object getInternalProperty(String key)

Specified by:

getInternalProperty in interface Configuration

close

public void close()
           throws Exception

Description copied from interface: DynamicConfiguration

Close the configuration

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DynamicConfiguration

Throws:

Exception