org.apache.dubbo.common.config.configcenter.file

Class FileSystemDynamicConfiguration

java.lang.Object

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

org.apache.dubbo.common.config.configcenter.file.FileSystemDynamicConfiguration

All Implemented Interfaces:

AutoCloseable, DynamicConfiguration, Configuration

public class FileSystemDynamicConfiguration
extends AbstractDynamicConfiguration

File-System based DynamicConfiguration implementation

Since:

2.7.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_CENTER_DIR_PARAM_NAME
static String	CONFIG_CENTER_ENCODING_PARAM_NAME
static String	DEFAULT_CONFIG_CENTER_DIR_PATH
static String	DEFAULT_CONFIG_CENTER_ENCODING
static int	DEFAULT_THREAD_POOL_SIZE

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

DEFAULT_THREAD_POOL_KEEP_ALIVE_TIME, DEFAULT_THREAD_POOL_PREFIX, PARAM_NAME_PREFIX, THREAD_POOL_KEEP_ALIVE_TIME_PARAM_NAME, THREAD_POOL_PREFIX_PARAM_NAME, THREAD_POOL_SIZE_PARAM_NAME

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

DEFAULT_GROUP

Constructor Summary

Constructors

Constructor and Description
FileSystemDynamicConfiguration()
FileSystemDynamicConfiguration(File rootDirectory)
FileSystemDynamicConfiguration(File rootDirectory, String encoding)
FileSystemDynamicConfiguration(File rootDirectory, String encoding, String threadPoolPrefixName)
FileSystemDynamicConfiguration(File rootDirectory, String encoding, String threadPoolPrefixName, int threadPoolSize)
FileSystemDynamicConfiguration(File rootDirectory, String encoding, String threadPoolPrefixName, int threadPoolSize, long keepAliveTime)
FileSystemDynamicConfiguration(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.
File	configFile(String key, String group)
Set<String>	getConfigGroups()
SortedSet<String>	getConfigKeys(String group) Get the config keys by the specified group
String	getEncoding()
Object	getInternalProperty(String key)
File	getRootDirectory()
File	groupDirectory(String group)
boolean	publishConfig(String key, String group, String content) Publish Config mapped to the given key and the given group.
String	removeConfig(String key, String 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 org.apache.dubbo.common.config.configcenter.AbstractDynamicConfiguration

close, getConfig

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

Field Detail

CONFIG_CENTER_DIR_PARAM_NAME

public static final String CONFIG_CENTER_DIR_PARAM_NAME

See Also:

Constant Field Values

CONFIG_CENTER_ENCODING_PARAM_NAME

public static final String CONFIG_CENTER_ENCODING_PARAM_NAME

See Also:

Constant Field Values

DEFAULT_CONFIG_CENTER_DIR_PATH

public static final String DEFAULT_CONFIG_CENTER_DIR_PATH

DEFAULT_THREAD_POOL_SIZE

public static final int DEFAULT_THREAD_POOL_SIZE

See Also:

Constant Field Values

DEFAULT_CONFIG_CENTER_ENCODING

public static final String DEFAULT_CONFIG_CENTER_ENCODING

See Also:

Constant Field Values

Constructor Detail

FileSystemDynamicConfiguration

public FileSystemDynamicConfiguration()

FileSystemDynamicConfiguration

public FileSystemDynamicConfiguration(File rootDirectory)

FileSystemDynamicConfiguration

public FileSystemDynamicConfiguration(File rootDirectory,
                                      String encoding)

FileSystemDynamicConfiguration

public FileSystemDynamicConfiguration(File rootDirectory,
                                      String encoding,
                                      String threadPoolPrefixName)

FileSystemDynamicConfiguration

public FileSystemDynamicConfiguration(File rootDirectory,
                                      String encoding,
                                      String threadPoolPrefixName,
                                      int threadPoolSize)

FileSystemDynamicConfiguration

public FileSystemDynamicConfiguration(File rootDirectory,
                                      String encoding,
                                      String threadPoolPrefixName,
                                      int threadPoolSize,
                                      long keepAliveTime)

FileSystemDynamicConfiguration

public FileSystemDynamicConfiguration(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

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

groupDirectory

public File groupDirectory(String group)

configFile

public File configFile(String key,
                       String group)

getInternalProperty

public Object getInternalProperty(String key)

Specified by:

getInternalProperty in interface Configuration

Overrides:

getInternalProperty in class AbstractDynamicConfiguration

publishConfig

public 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

getConfigKeys

public SortedSet<String> getConfigKeys(String group)

Description copied from interface: DynamicConfiguration

Get the config keys by the specified group

Parameters:

group - the specified group

Returns:

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

removeConfig

public String removeConfig(String key,
                           String group)

getConfigGroups

public Set<String> getConfigGroups()

getRootDirectory

public File getRootDirectory()

getEncoding

public String getEncoding()