org.apache.dubbo.common.config

Class ModuleEnvironment

java.lang.Object

org.apache.dubbo.common.context.LifecycleAdapter

org.apache.dubbo.common.config.Environment

org.apache.dubbo.common.config.ModuleEnvironment

All Implemented Interfaces:

ApplicationExt, Lifecycle, ModuleExt, Disposable

public class ModuleEnvironment
extends Environment
implements ModuleExt

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
ModuleEnvironment(ModuleModel moduleModel)

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(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	setAppConfigMap(Map<String,String> appConfiguration)
void	setAppExternalConfigMap(Map<String,String> appExternalConfiguration)
void	setDynamicConfiguration(DynamicConfiguration dynamicConfiguration)
void	setExternalConfigMap(Map<String,String> externalConfiguration)
void	setLocalMigrationRule(String localMigrationRule)
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.config.Environment

getConfigurationMaps, reset, resolvePlaceholders

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

ModuleEnvironment

public ModuleEnvironment(ModuleModel moduleModel)

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 Environment

Throws:

IllegalStateException

getPrefixedConfiguration

public Configuration getPrefixedConfiguration(AbstractConfig config,
                                              String prefix)

Description copied from class: Environment

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.

Overrides:

getPrefixedConfiguration in class Environment

Returns:

getConfiguration

public CompositeConfiguration getConfiguration()

Description copied from class: Environment

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.

Overrides:

getConfiguration in class Environment

getConfigurationMaps

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

Description copied from class: Environment

Get configuration map list for target instance

Overrides:

getConfigurationMaps in class Environment

Returns:

getDynamicGlobalConfiguration

public Configuration getDynamicGlobalConfiguration()

Overrides:

getDynamicGlobalConfiguration in class Environment

getDynamicConfiguration

public Optional<DynamicConfiguration> getDynamicConfiguration()

Overrides:

getDynamicConfiguration in class Environment

setDynamicConfiguration

@DisableInject
public void setDynamicConfiguration(DynamicConfiguration dynamicConfiguration)

Overrides:

setDynamicConfiguration in class Environment

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 Environment

Throws:

IllegalStateException

setLocalMigrationRule

@DisableInject
public void setLocalMigrationRule(String localMigrationRule)

Overrides:

setLocalMigrationRule in class Environment

setExternalConfigMap

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

Overrides:

setExternalConfigMap in class Environment

setAppExternalConfigMap

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

Overrides:

setAppExternalConfigMap in class Environment

setAppConfigMap

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

Overrides:

setAppConfigMap in class Environment

getExternalConfigMap

public Map<String,String> getExternalConfigMap()

Overrides:

getExternalConfigMap in class Environment

getAppExternalConfigMap

public Map<String,String> getAppExternalConfigMap()

Overrides:

getAppExternalConfigMap in class Environment

getAppConfigMap

public Map<String,String> getAppConfigMap()

Overrides:

getAppConfigMap in class Environment

updateExternalConfigMap

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

Overrides:

updateExternalConfigMap in class Environment

updateAppExternalConfigMap

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

Overrides:

updateAppExternalConfigMap in class Environment

updateAppConfigMap

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

Description copied from class: Environment

Merge target map properties into app configuration

Overrides:

updateAppConfigMap in class Environment

getPropertiesConfiguration

public PropertiesConfiguration getPropertiesConfiguration()

Overrides:

getPropertiesConfiguration in class Environment

getSystemConfiguration

public SystemConfiguration getSystemConfiguration()

Overrides:

getSystemConfiguration in class Environment

getEnvironmentConfiguration

public EnvironmentConfiguration getEnvironmentConfiguration()

Overrides:

getEnvironmentConfiguration in class Environment

getExternalConfiguration

public InmemoryConfiguration getExternalConfiguration()

Overrides:

getExternalConfiguration in class Environment

getAppExternalConfiguration

public InmemoryConfiguration getAppExternalConfiguration()

Overrides:

getAppExternalConfiguration in class Environment

getAppConfiguration

public InmemoryConfiguration getAppConfiguration()

Overrides:

getAppConfiguration in class Environment

getLocalMigrationRule

public String getLocalMigrationRule()

Overrides:

getLocalMigrationRule in class Environment

refreshClassLoaders

public void refreshClassLoaders()

Overrides:

refreshClassLoaders in class Environment