- All Known Subinterfaces:
- All Known Implementing Classes:
Environmenttypes. Provides facilities for setting active and default profiles and manipulating underlying property sources. Allows clients to set and validate required properties, customize the conversion service and more through the
Manipulating property sources
Property sources may be removed, reordered, or replaced; and additional
property sources may be added using the
instance returned from
getPropertySources(). The following examples
are against the
StandardEnvironment implementation of
ConfigurableEnvironment, but are generally applicable to any implementation,
though particular default property sources may differ.
Example: adding a new property source with highest search priority
ConfigurableEnvironment environment = new StandardEnvironment(); MutablePropertySources propertySources = environment.getPropertySources(); Map<String, String> 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(StandardEnvironment.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(StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, mockEnvVars);When an
Environmentis being used by an
ApplicationContext, it is important that any such
PropertySourcemanipulations be performed before the context's
refresh()method is called. This ensures that all property sources are available during the container bootstrap process, including use by property placeholder configurers.
Method SummaryModifier and TypeMethodDescription
voidAdd a profile to the current set of active profiles.Return the value of
System.getenv().Return the value of
voidAppend the given parent environment's active profiles, default profiles and property sources to this (child) environment's respective collections of each.
voidSpecify the set of profiles active for this
voidSpecify the set of profiles to be made active by default if no other profiles are explicitly made active through
Methods inherited from interface org.springframework.core.env.ConfigurablePropertyResolver
getConversionService, setConversionService, setIgnoreUnresolvableNestedPlaceholders, setPlaceholderPrefix, setPlaceholderSuffix, setRequiredProperties, setValueSeparator, validateRequiredProperties
Methods inherited from interface org.springframework.core.env.Environment
acceptsProfiles, acceptsProfiles, getActiveProfiles, getDefaultProfiles
(String... profiles)Specify the set of profiles active for this
Environment. Profiles are evaluated during container bootstrap to determine whether bean definitions should be registered with the container.
Any existing active profiles will be replaced with the given arguments; call with zero arguments to clear the current set of active profiles. Use
addActiveProfile(java.lang.String)to add a profile while preserving the existing set.
(String profile)Add a profile to the current set of active profiles.
(String... profiles)Specify the set of profiles to be made active by default if no other profiles are explicitly made active through
IllegalArgumentException- if any profile is null, empty or whitespace-only
- See Also:
getPropertySourcesMutablePropertySources getPropertySources()Return the
Environmentin mutable form, allowing for manipulation of the set of
PropertySourceobjects that should be searched when resolving properties against this
Environmentobject. The various
MutablePropertySourcesmethods such as
addAfterallow for fine-grained control over property source ordering. This is useful, for example, in ensuring that certain user-defined property sources have search precedence over default property sources such as the set of system properties or the set of system environment variables.
getSystemPropertiesReturn the value of
Note that most
Environmentimplementations will include this system properties map as a default
PropertySourceto be searched. Therefore, it is recommended that this method not be used directly unless bypassing other property sources is expressly intended.
(ConfigurableEnvironment parent)Append the given parent environment's active profiles, default profiles and property sources to this (child) environment's respective collections of each.
For any identically-named
PropertySourceinstance existing in both parent and child, the child instance is to be preserved and the parent instance discarded. This has the effect of allowing overriding of property sources by the child as well as avoiding redundant searches through common property source types, e.g. system environment and system properties.
Active and default profile names are also filtered for duplicates, to avoid confusion and redundant storage.
The parent environment remains unmodified in any case. Note that any changes to the parent environment occurring after the call to
mergewill not be reflected in the child. Therefore, care should be taken to configure parent property sources and profile information prior to calling
parent- the environment to merge with
- See Also: