org.apache.dubbo.common.config

Class Environment

java.lang.Object

org.apache.dubbo.common.context.LifecycleAdapter

org.apache.dubbo.common.config.Environment

All Implemented Interfaces:

ApplicationExt, Lifecycle, Disposable

Direct Known Subclasses:

ModuleEnvironment

public class Environment
extends LifecycleAdapter
implements ApplicationExt

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
Environment(ScopeModel scopeModel)

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroy the component
Map<String,String>	getAppConfigMap()
InmemoryConfiguration	getAppConfiguration()
Map<String,String>	getAppExternalConfigMap()
InmemoryConfiguration	getAppExternalConfiguration()
CompositeConfiguration	getConfiguration() There are two ways to get configuration during exposure / reference or at runtime: 1.
List<Map<String,String>>	getConfigurationMaps() Get global configuration as map list
List<Map<String,String>>	getConfigurationMaps(AbstractConfig config, String prefix) Get configuration map list for target instance
Optional<DynamicConfiguration>	getDynamicConfiguration()
Configuration	getDynamicGlobalConfiguration()
EnvironmentConfiguration	getEnvironmentConfiguration()
Map<String,String>	getExternalConfigMap()
InmemoryConfiguration	getExternalConfiguration()
String	getLocalMigrationRule()
Configuration	getPrefixedConfiguration(AbstractConfig config, String prefix) At start-up, Dubbo is driven by various configuration, such as Application, Registry, Protocol, etc.
PropertiesConfiguration	getPropertiesConfiguration()
SystemConfiguration	getSystemConfiguration()
void	initialize() Initialize the component before start
void	refreshClassLoaders()
void	reset() Reset environment.
String	resolvePlaceholders(String str)
void	setAppConfigMap(Map<String,String> appConfiguration)
void	setAppExternalConfigMap(Map<String,String> appExternalConfiguration)
void	setDynamicConfiguration(DynamicConfiguration defaultDynamicConfiguration)
void	setExternalConfigMap(Map<String,String> externalConfiguration)
void	setLocalMigrationRule(String localMigrationRule) Deprecated. only for ut
void	updateAppConfigMap(Map<String,String> map) Merge target map properties into app configuration
void	updateAppExternalConfigMap(Map<String,String> externalMap)
void	updateExternalConfigMap(Map<String,String> externalMap)

Methods inherited from class org.apache.dubbo.common.context.LifecycleAdapter

start

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.dubbo.common.context.Lifecycle

start

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

Environment

public Environment(ScopeModel scopeModel)

Method Detail

initialize

public void initialize()
                throws IllegalStateException

Description copied from interface: Lifecycle

Initialize the component before start

Specified by:

initialize in interface Lifecycle

Overrides:

initialize in class LifecycleAdapter

Throws:

IllegalStateException

setLocalMigrationRule

@Deprecated
 @DisableInject
public void setLocalMigrationRule(String localMigrationRule)

Deprecated. only for ut

setExternalConfigMap

@DisableInject
public void setExternalConfigMap(Map<String,String> externalConfiguration)

setAppExternalConfigMap

@DisableInject
public void setAppExternalConfigMap(Map<String,String> appExternalConfiguration)

setAppConfigMap

@DisableInject
public void setAppConfigMap(Map<String,String> appConfiguration)

getExternalConfigMap

public Map<String,String> getExternalConfigMap()

getAppExternalConfigMap

public Map<String,String> getAppExternalConfigMap()

getAppConfigMap

public Map<String,String> getAppConfigMap()

updateExternalConfigMap

public void updateExternalConfigMap(Map<String,String> externalMap)

updateAppExternalConfigMap

public void updateAppExternalConfigMap(Map<String,String> externalMap)

updateAppConfigMap

public void updateAppConfigMap(Map<String,String> map)

Merge target map properties into app configuration

Parameters:

map -

getPrefixedConfiguration

public Configuration getPrefixedConfiguration(AbstractConfig config,
                                              String prefix)

At start-up, Dubbo is driven by various configuration, such as Application, Registry, Protocol, etc. All configurations will be converged into a data bus - URL, and then drive the subsequent process.

At present, there are many configuration sources, including AbstractConfig (API, XML, annotation), - D, config center, etc. This method helps us t filter out the most priority values from various configuration sources.

Parameters:

config -

prefix -

Returns:

getConfiguration

public CompositeConfiguration getConfiguration()

There are two ways to get configuration during exposure / reference or at runtime: 1. URL, The value in the URL is relatively fixed. we can get value directly. 2. The configuration exposed in this method is convenient for us to query the latest values from multiple prioritized sources, it also guarantees that configs changed dynamically can take effect on the fly.

getConfigurationMaps

public List<Map<String,String>> getConfigurationMaps(AbstractConfig config,
                                                     String prefix)

Get configuration map list for target instance

Parameters:

config -

prefix -

Returns:

getConfigurationMaps

public List<Map<String,String>> getConfigurationMaps()

Get global configuration as map list

Returns:

destroy

public void destroy()
             throws IllegalStateException

Description copied from interface: Lifecycle

Destroy the component

Specified by:

destroy in interface Lifecycle

Specified by:

destroy in interface Disposable

Overrides:

destroy in class LifecycleAdapter

Throws:

IllegalStateException

reset

public void reset()

Reset environment. For test only.

resolvePlaceholders

public String resolvePlaceholders(String str)

getPropertiesConfiguration

public PropertiesConfiguration getPropertiesConfiguration()

getSystemConfiguration

public SystemConfiguration getSystemConfiguration()

getEnvironmentConfiguration

public EnvironmentConfiguration getEnvironmentConfiguration()

getExternalConfiguration

public InmemoryConfiguration getExternalConfiguration()

getAppExternalConfiguration

public InmemoryConfiguration getAppExternalConfiguration()

getAppConfiguration

public InmemoryConfiguration getAppConfiguration()

getLocalMigrationRule

public String getLocalMigrationRule()

refreshClassLoaders

public void refreshClassLoaders()

getDynamicGlobalConfiguration

public Configuration getDynamicGlobalConfiguration()

getDynamicConfiguration

public Optional<DynamicConfiguration> getDynamicConfiguration()

setDynamicConfiguration

@DisableInject
public void setDynamicConfiguration(DynamicConfiguration defaultDynamicConfiguration)