DefaultEnvironment

Class Overview

Default implementation of the Environment interface. Used throughout all non-Web* ApplicationContext implementations.

In addition to the usual functions of a ConfigurableEnvironment such as property resolution and profile-related operations, this implementation configures two default property sources, to be searched in the following order:

1. system properties
2. system environment variables

That is, if the key "xyz" is present both in the JVM system properties as well as in the set of environment variables for the current process, the value of key "xyz" from system properties will return from a call to environment.getPropertyResolver().getProperty("xyz"). This ordering is chosen by default because system properties are per-JVM, while environment variables may be the same across many JVMs on a given system. Giving system properties precedence allows for overriding of environment variables on a per-JVM basis.

These default property sources may be removed, reordered, or replaced; and additional property sources may be added using the MutablePropertySources instance available from getPropertySources().

Example: adding a new property source with highest search priority

   ConfigurableEnvironment environment = new DefaultEnvironment();
   MutablePropertySources propertySources = environment.getPropertySources();
   Map myMap = new HashMap();
   myMap.put("xyz", "myValue");
   propertySources.addFirst(new MapPropertySource("MY_MAP", myMap));
 

Example: removing the default system properties property source

   MutablePropertySources propertySources = environment.getPropertySources();
   propertySources.remove(DefaultEnvironment.SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME)
 

Example: mocking the system environment for testing purposes

   MutablePropertySources propertySources = environment.getPropertySources();
   MockPropertySource mockEnvVars = new MockPropertySource().withProperty("xyz", "myValue");
   propertySources.replace(DefaultEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, mockEnvVars);
 

When an Environment is being used by an ApplicationContext, it is important that any such PropertySource manipulations be performed before the context's refresh() method is called. This ensures that all PropertySources are available during the container bootstrap process, including use by property placeholder configurers.

Summary

Constants
String	SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME	System environment property source name: {@value }
String	SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME	JVM system properties property source name: {@value }

[Expand] Inherited Constants
From class org.springframework.core.env.AbstractEnvironment String ACTIVE_PROFILES_PROPERTY_NAME Name of property to set to specify active profiles: {@value }. String DEFAULT_PROFILES_PROPERTY_NAME Name of property to set to specify default profiles: {@value }.

[Expand] Inherited Fields
From class org.springframework.core.env.AbstractEnvironment protected final Log logger

Public Constructors
	DefaultEnvironment() Create a new Environment populated with property sources in the following order: {@value #SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME} {@value #SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME} Properties present in {@value #SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME} will take precedence over those in {@value #SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME}.

[Expand] Inherited Methods
From class org.springframework.core.env.AbstractEnvironment boolean acceptsProfiles(String... profiles) boolean containsProperty(String key) Return whether the given property key is available for resolution. Set<String> doGetActiveProfiles() Set<String> doGetDefaultProfiles() String[] getActiveProfiles() Return the set of profiles explicitly made active for this environment. ConversionService getConversionService() String[] getDefaultProfiles() Return the set of profiles to be active by default when no active profiles have been set explicitly. <T> T getProperty(String key, Class<T> targetType) Return the property value associated with the given key, or null if the key cannot be resolved. String getProperty(String key) Return the property value associated with the given key. ConfigurablePropertyResolver getPropertyResolver() MutablePropertySources getPropertySources() Return the PropertySources for this environment in mutable form String getRequiredProperty(String key) Return the property value associated with the given key, converted to the given targetType (never null). <T> T getRequiredProperty(String key, Class<T> targetType) Return the property value associated with the given key, converted to the given targetType (never null). Map<String, Object> getSystemEnvironment() Return the value of getenv() if allowed by the current SecurityManager, otherwise return a map implementation that will attempt to access individual keys using calls to getenv(String). Map<String, Object> getSystemProperties() Return the value of getProperties() if allowed by the current SecurityManager, otherwise return a map implementation that will attempt to access individual keys using calls to getProperty(String). String resolvePlaceholders(String text) Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by getProperty(String). String resolveRequiredPlaceholders(String text) Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by getProperty(String). void setActiveProfiles(String... profiles) Specify the set of profiles active for this Environment. void setConversionService(ConversionService conversionService) Set the ConversionService to be used when performing type conversions on properties. void setDefaultProfiles(String... profiles) Specify the set of profiles to be made active by default if no other profiles are explicitly made active through setActiveProfiles(String...). void setPlaceholderPrefix(String placeholderPrefix) void setPlaceholderSuffix(String placeholderSuffix) void setValueSeparator(String valueSeparator) String toString()
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.core.env.ConfigurableEnvironment abstract MutablePropertySources getPropertySources() Return the PropertySources for this environment in mutable form abstract Map<String, Object> getSystemEnvironment() Return the value of getenv() if allowed by the current SecurityManager, otherwise return a map implementation that will attempt to access individual keys using calls to getenv(String). abstract Map<String, Object> getSystemProperties() Return the value of getProperties() if allowed by the current SecurityManager, otherwise return a map implementation that will attempt to access individual keys using calls to getProperty(String). abstract void setActiveProfiles(String... profiles) Specify the set of profiles active for this Environment. abstract void setDefaultProfiles(String... profiles) Specify the set of profiles to be made active by default if no other profiles are explicitly made active through setActiveProfiles(String...).
From interface org.springframework.core.env.ConfigurablePropertyResolver abstract ConversionService getConversionService() abstract void setConversionService(ConversionService conversionService) Set the ConversionService to be used when performing type conversions on properties. abstract void setPlaceholderPrefix(String placeholderPrefix) abstract void setPlaceholderSuffix(String placeholderSuffix) abstract void setValueSeparator(String valueSeparator)
From interface org.springframework.core.env.Environment abstract boolean acceptsProfiles(String... profiles) abstract String[] getActiveProfiles() Return the set of profiles explicitly made active for this environment. abstract String[] getDefaultProfiles() Return the set of profiles to be active by default when no active profiles have been set explicitly.
From interface org.springframework.core.env.PropertyResolver abstract boolean containsProperty(String key) Return whether the given property key is available for resolution. abstract <T> T getProperty(String key, Class<T> targetType) Return the property value associated with the given key, or null if the key cannot be resolved. abstract String getProperty(String key) Return the property value associated with the given key. abstract String getRequiredProperty(String key) Return the property value associated with the given key, converted to the given targetType (never null). abstract <T> T getRequiredProperty(String key, Class<T> targetType) Return the property value associated with the given key, converted to the given targetType (never null). abstract String resolvePlaceholders(String text) Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by getProperty(String). abstract String resolveRequiredPlaceholders(String text) Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by getProperty(String).