Package org.apache.dubbo.common.config.configcenter

Class TreePathDynamicConfiguration

java.lang.Object

org.apache.dubbo.common.config.configcenter.AbstractDynamicConfiguration

org.apache.dubbo.common.config.configcenter.TreePathDynamicConfiguration

All Implemented Interfaces:

AutoCloseable, DynamicConfiguration, Configuration

public abstract class TreePathDynamicConfiguration
extends AbstractDynamicConfiguration

An abstract implementation of DynamicConfiguration is like "tree-structure" path :

• invalid reference

  "file"

• invalid reference

  "zookeeper"

Since:

2.7.8

See Also:

• DynamicConfiguration
• AbstractDynamicConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_BASE_PATH_PARAM_NAME	The parameter name of URL for the config base path
static final String	CONFIG_ROOT_PATH_PARAM_NAME	The parameter name of URL for the config root path
static final String	DEFAULT_CONFIG_BASE_PATH	The default value of parameter of URL for the config base path

Fields inherited from class org.apache.dubbo.common.config.configcenter.AbstractDynamicConfiguration

DEFAULT_THREAD_POOL_KEEP_ALIVE_TIME, DEFAULT_THREAD_POOL_PREFIX, DEFAULT_THREAD_POOL_SIZE, GROUP_PARAM_NAME, PARAM_NAME_PREFIX, THREAD_POOL_KEEP_ALIVE_TIME_PARAM_NAME, THREAD_POOL_PREFIX_PARAM_NAME, THREAD_POOL_SIZE_PARAM_NAME, TIMEOUT_PARAM_NAME

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

interfaceLevelLogger

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

DEFAULT_GROUP

Constructor Summary

Constructors

Constructor	Description
TreePathDynamicConfiguration(String rootPath, String threadPoolPrefixName, int threadPoolSize, long keepAliveTime, String group, long timeout)
TreePathDynamicConfiguration(URL url)

Method Summary

Modifier and Type	Method	Description
final 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.
final boolean	publishConfig(String key, String group, String content)	Publish Config mapped to the given key and the given group.
final void	removeListener(String key, String group, ConfigurationListener listener)	Stops one listener from listening to value changes in the specified key.

Methods inherited from class org.apache.dubbo.common.config.configcenter.AbstractDynamicConfiguration

close, getConfig, getDefaultGroup, getDefaultTimeout, getInternalProperty, removeConfig

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.Configuration

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

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

addListener, getConfig, getConfigItem, getProperties, getProperties, publishConfig, publishConfigCas, removeListener

Field Details

CONFIG_ROOT_PATH_PARAM_NAME

public static final String CONFIG_ROOT_PATH_PARAM_NAME

The parameter name of URL for the config root path

See Also:

• Constant Field Values

CONFIG_BASE_PATH_PARAM_NAME

public static final String CONFIG_BASE_PATH_PARAM_NAME

The parameter name of URL for the config base path

See Also:

• Constant Field Values

DEFAULT_CONFIG_BASE_PATH

public static final String DEFAULT_CONFIG_BASE_PATH

The default value of parameter of URL for the config base path

See Also:

• Constant Field Values

Constructor Details

TreePathDynamicConfiguration

public TreePathDynamicConfiguration(URL url)

TreePathDynamicConfiguration

public TreePathDynamicConfiguration(String rootPath,
 String threadPoolPrefixName,
 int threadPoolSize,
 long keepAliveTime,
 String group,
 long timeout)

Method Details

publishConfig

public final boolean publishConfig(String key,
 String group,
 String content)

Description copied from interface: DynamicConfiguration

Publish Config 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

content - the content of configuration

Returns:

true if success, or false

addListener

public final 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

Overrides:

addListener in class AbstractDynamicConfiguration

Parameters:

key - the key to represent a configuration

group - the group where the key belongs to

listener - configuration listener

removeListener

public final 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

Overrides:

removeListener in class AbstractDynamicConfiguration

Parameters:

key - the key to represent a configuration

group - the group where the key belongs to

listener - configuration listener