Spring Framework 6.1.4 · org.springframework.core.env.AbstractEnvironment

Modifier and Type	Field and Description
public static final String	ACTIVE_PROFILES_PROPERTY_NAME Name of the property to set to specify active profiles: spring.profiles.active.
private final Set<String>	activeProfiles
public static final String	DEFAULT_PROFILES_PROPERTY_NAME Name of the property to set to specify profiles that are active by default: spring.profiles.default.
private final Set<String>	defaultProfiles
public static final String	IGNORE_GETENV_PROPERTY_NAME System property that instructs Spring to ignore system environment variables, i.e. to never attempt to retrieve such a variable via `System#getenv()`.
protected final Log	logger
private final ConfigurablePropertyResolver	propertyResolver
private final MutablePropertySources	propertySources
public static final String	RESERVED_DEFAULT_PROFILE_NAME Name of the reserved default profile name: default.

Access	Constructor and Description
public	AbstractEnvironment() Create a new `Environment` instance, calling back to `customizePropertySources(MutablePropertySources)` during construction to allow subclasses to contribute or manipulate `PropertySource` instances as appropriate.
protected	AbstractEnvironment(MutablePropertySources property sources to use propertySources) Create a new `Environment` instance with a specific `MutablePropertySources` instance, calling back to `customizePropertySources(MutablePropertySources)` during construction to allow subclasses to contribute or manipulate `PropertySource` instances as appropriate.

Method Summary

Modifier and Type	Method and Description
public boolean	acceptsProfiles(String... profiles) Implements org.springframework.core.env.Environment.acceptsProfiles. Deprecated Determine whether one or more of the given profiles is active — or in the case of no explicit active profiles, whether one or more of the given profiles is included in the set of default profiles.
public boolean	acceptsProfiles(Profiles profiles) Implements org.springframework.core.env.Environment.acceptsProfiles. Determine whether the given `Profiles` predicate matches the active profiles — or in the case of no explicit active profiles, whether the given `Profiles` predicate matches the default profiles.
public void	addActiveProfile(String profile) Implements org.springframework.core.env.ConfigurableEnvironment.addActiveProfile. Add a profile to the current set of active profiles.
public boolean	containsProperty(String key) Implements org.springframework.core.env.PropertyResolver.containsProperty. Return whether the given property key is available for resolution, i.e. if the value for the given key is not `null`.
protected ConfigurablePropertyResolver	createPropertyResolver(MutablePropertySources propertySources) Factory method used to create the `ConfigurablePropertyResolver` instance used by the Environment.
protected void	customizePropertySources(MutablePropertySources propertySources) Customize the set of `PropertySource` objects to be searched by this `Environment` during calls to `getProperty(String)` and related methods.
protected Set<String>	doGetActiveProfiles() Return the set of active profiles as explicitly set through `setActiveProfiles` or if the current set of active profiles is empty, check for the presence of `doGetActiveProfilesProperty()` and assign its value to the set of active profiles.
protected String	doGetActiveProfilesProperty() Return the property value for the active profiles.
protected Set<String>	doGetDefaultProfiles() Return the set of default profiles explicitly set via `setDefaultProfiles(String...)` or if the current set of default profiles consists only of reserved default profiles, then check for the presence of `doGetActiveProfilesProperty()` and assign its value (if any) to the set of default profiles.
protected String	doGetDefaultProfilesProperty() Return the property value for the default profiles.
public String[]	getActiveProfiles() Implements org.springframework.core.env.Environment.getActiveProfiles. Return the set of profiles explicitly made active for this environment.
public ConfigurableConversionService	getConversionService() Implements org.springframework.core.env.ConfigurablePropertyResolver.getConversionService. Return the `ConfigurableConversionService` used when performing type conversions on properties.
public String[]	getDefaultProfiles() Implements org.springframework.core.env.Environment.getDefaultProfiles. Return the set of profiles to be active by default when no active profiles have been set explicitly.
public String	getProperty(String the property name to resolve key) Implements org.springframework.core.env.PropertyResolver.getProperty. Return the property value associated with the given key, or `null` if the key cannot be resolved.
public String	getProperty(String the property name to resolve key, String the default value to return if no value is found defaultValue) Implements org.springframework.core.env.PropertyResolver.getProperty. Return the property value associated with the given key, or `defaultValue` if the key cannot be resolved.
public <T> T	getProperty(String the property name to resolve key, Class<T> the expected type of the property value targetType) Implements org.springframework.core.env.PropertyResolver.getProperty. Return the property value associated with the given key, or `null` if the key cannot be resolved.
public <T> T	getProperty(String the property name to resolve key, Class<T> the expected type of the property value targetType, T the default value to return if no value is found defaultValue) Implements org.springframework.core.env.PropertyResolver.getProperty. Return the property value associated with the given key, or `defaultValue` if the key cannot be resolved.
protected final ConfigurablePropertyResolver	getPropertyResolver() Return the `ConfigurablePropertyResolver` being used by the `Environment`.
public MutablePropertySources	getPropertySources() Implements org.springframework.core.env.ConfigurableEnvironment.getPropertySources. Return the `PropertySources` for this `Environment` in mutable form, allowing for manipulation of the set of `PropertySource` objects that should be searched when resolving properties against this `Environment` object.
public String	getRequiredProperty(String key) Implements org.springframework.core.env.PropertyResolver.getRequiredProperty. Return the property value associated with the given key (never `null`).
public <T> T	getRequiredProperty(String key, Class<T> targetType) Implements org.springframework.core.env.PropertyResolver.getRequiredProperty. Return the property value associated with the given key, converted to the given targetType (never `null`).
protected Set<String>	getReservedDefaultProfiles() Return the set of reserved default profile names.
public Map<String, Object>	getSystemEnvironment() Implements org.springframework.core.env.ConfigurableEnvironment.getSystemEnvironment. Return the value of `System#getenv()`.
public Map<String, Object>	getSystemProperties() Implements org.springframework.core.env.ConfigurableEnvironment.getSystemProperties. Return the value of `System#getProperties()`.
protected boolean	isProfileActive(String profile) Return whether the given profile is active, or if active profiles are empty whether the profile should be active by default.
public void	merge(ConfigurableEnvironment the environment to merge with parent) Implements org.springframework.core.env.ConfigurableEnvironment.merge. Append the given parent environment's active profiles, default profiles and property sources to this (child) environment's respective collections of each.
public String	resolvePlaceholders(String the String to resolve text) Implements org.springframework.core.env.PropertyResolver.resolvePlaceholders. Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by `getProperty`.
public String	resolveRequiredPlaceholders(String text) Implements org.springframework.core.env.PropertyResolver.resolveRequiredPlaceholders. Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by `getProperty`.
public void	setActiveProfiles(String... profiles) Implements org.springframework.core.env.ConfigurableEnvironment.setActiveProfiles. Specify the set of profiles active for this `Environment`.
public void	setConversionService(ConfigurableConversionService conversionService) Implements org.springframework.core.env.ConfigurablePropertyResolver.setConversionService. Set the `ConfigurableConversionService` to be used when performing type conversions on properties.
public void	setDefaultProfiles(String... profiles) Implements org.springframework.core.env.ConfigurableEnvironment.setDefaultProfiles. Specify the set of profiles to be made active by default if no other profiles are explicitly made active through `setActiveProfiles`.
public void	setIgnoreUnresolvableNestedPlaceholders(boolean ignoreUnresolvableNestedPlaceholders) Implements org.springframework.core.env.ConfigurablePropertyResolver.setIgnoreUnresolvableNestedPlaceholders. Set whether to throw an exception when encountering an unresolvable placeholder nested within the value of a given property.
public void	setPlaceholderPrefix(String placeholderPrefix) Implements org.springframework.core.env.ConfigurablePropertyResolver.setPlaceholderPrefix. Set the prefix that placeholders replaced by this resolver must begin with.
public void	setPlaceholderSuffix(String placeholderSuffix) Implements org.springframework.core.env.ConfigurablePropertyResolver.setPlaceholderSuffix. Set the suffix that placeholders replaced by this resolver must end with.
public void	setRequiredProperties(String... requiredProperties) Implements org.springframework.core.env.ConfigurablePropertyResolver.setRequiredProperties. Specify which properties must be present, to be verified by `validateRequiredProperties()`.
public void	setValueSeparator(String valueSeparator) Implements org.springframework.core.env.ConfigurablePropertyResolver.setValueSeparator. Specify the separating character between the placeholders replaced by this resolver and their associated default value, or `null` if no such special character should be processed as a value separator.
protected boolean	suppressGetenvAccess() Determine whether to suppress `System#getenv()`/`System#getenv(String)` access for the purposes of `getSystemEnvironment()`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected void	validateProfile(String profile) Validate the given profile, called internally prior to adding to the set of active or default profiles.
public void	validateRequiredProperties() Implements org.springframework.core.env.ConfigurablePropertyResolver.validateRequiredProperties. Validate that each of the properties specified by `setRequiredProperties` is present and resolves to a non-`null` value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

ACTIVE_PROFILES_PROPERTY_NAME	back to summary
public static final String ACTIVE_PROFILES_PROPERTY_NAME Name of the property to set to specify active profiles: spring.profiles.active. The value may be comma delimited. Note that certain shell environments such as Bash disallow the use of the period character in variable names. Assuming that Spring's `SystemEnvironmentPropertySource` is in use, this property may be specified as an environment variable named `SPRING_PROFILES_ACTIVE`. See Also `ConfigurableEnvironment#setActiveProfiles`

activeProfiles	back to summary
private final Set<String> activeProfiles

DEFAULT_PROFILES_PROPERTY_NAME	back to summary
public static final String DEFAULT_PROFILES_PROPERTY_NAME Name of the property to set to specify profiles that are active by default: spring.profiles.default. The value may be comma delimited. Note that certain shell environments such as Bash disallow the use of the period character in variable names. Assuming that Spring's `SystemEnvironmentPropertySource` is in use, this property may be specified as an environment variable named `SPRING_PROFILES_DEFAULT`. See Also `ConfigurableEnvironment#setDefaultProfiles`

defaultProfiles	back to summary
private final Set<String> defaultProfiles

IGNORE_GETENV_PROPERTY_NAME	back to summary
public static final String IGNORE_GETENV_PROPERTY_NAME System property that instructs Spring to ignore system environment variables, i.e. to never attempt to retrieve such a variable via `System#getenv()`. The default is "false", falling back to system environment variable checks if a Spring environment property (e.g. a placeholder in a configuration String) isn't resolvable otherwise. Consider switching this flag to "true" if you experience log warnings from `getenv` calls coming from Spring. See Also `suppressGetenvAccess()`

logger	back to summary
protected final Log logger

propertyResolver	back to summary
private final ConfigurablePropertyResolver propertyResolver

propertySources	back to summary
private final MutablePropertySources propertySources

RESERVED_DEFAULT_PROFILE_NAME	back to summary
public static final String RESERVED_DEFAULT_PROFILE_NAME Name of the reserved default profile name: default. If no default profile names are explicitly set and no active profile names are explicitly set, this profile will automatically be activated by default. See Also `getReservedDefaultProfiles`, `ConfigurableEnvironment#setDefaultProfiles`, `ConfigurableEnvironment#setActiveProfiles`, `AbstractEnvironment#DEFAULT_PROFILES_PROPERTY_NAME`, `AbstractEnvironment#ACTIVE_PROFILES_PROPERTY_NAME`

AbstractEnvironment	back to summary
public AbstractEnvironment() Create a new `Environment` instance, calling back to `customizePropertySources(MutablePropertySources)` during construction to allow subclasses to contribute or manipulate `PropertySource` instances as appropriate. See Also `customizePropertySources(MutablePropertySources)`

AbstractEnvironment	back to summary
protected AbstractEnvironment(MutablePropertySources propertySources) Create a new `Environment` instance with a specific `MutablePropertySources` instance, calling back to `customizePropertySources(MutablePropertySources)` during construction to allow subclasses to contribute or manipulate `PropertySource` instances as appropriate. Parameters propertySources:MutablePropertySources property sources to use Since 5.3.4 See Also `customizePropertySources(MutablePropertySources)`

Method Detail

acceptsProfiles back to summary

acceptsProfiles	back to summary
public boolean acceptsProfiles(String... profiles) Implements org.springframework.core.env.Environment.acceptsProfiles. Doc from org.springframework.core.env.Environment.acceptsProfiles. Deprecated Determine whether one or more of the given profiles is active — or in the case of no explicit active profiles, whether one or more of the given profiles is included in the set of default profiles. If a profile begins with '!' the logic is inverted, meaning this method will return `true` if the given profile is not active. For example, `env.acceptsProfiles("p1", "!p2")` will return `true` if profile 'p1' is active or 'p2' is not active. Annotations @Override @Deprecated

public boolean acceptsProfiles(String... profiles)

Implements org.springframework.core.env.Environment.acceptsProfiles.

Doc from org.springframework.core.env.Environment.acceptsProfiles.

Deprecated

Determine whether one or more of the given profiles is active — or in the case of no explicit active profiles, whether one or more of the given profiles is included in the set of default profiles.

If a profile begins with '!' the logic is inverted, meaning this method will return true if the given profile is not active. For example, env.acceptsProfiles("p1", "!p2") will return true if profile 'p1' is active or 'p2' is not active.

Annotations

@Override
@Deprecated

acceptsProfiles back to summary

acceptsProfiles	back to summary
public boolean acceptsProfiles(Profiles profiles) Implements org.springframework.core.env.Environment.acceptsProfiles. Doc from org.springframework.core.env.Environment.acceptsProfiles. Determine whether the given `Profiles` predicate matches the active profiles — or in the case of no explicit active profiles, whether the given `Profiles` predicate matches the default profiles. If you wish provide profile expressions directly as strings, use `matchesProfiles(String...)` instead. Annotations @Override

public boolean acceptsProfiles(Profiles profiles)

Implements org.springframework.core.env.Environment.acceptsProfiles.

Doc from org.springframework.core.env.Environment.acceptsProfiles.

Determine whether the given Profiles predicate matches the active profiles — or in the case of no explicit active profiles, whether the given Profiles predicate matches the default profiles.

If you wish provide profile expressions directly as strings, use matchesProfiles(String...) instead.

Annotations

@Override

addActiveProfile	back to summary
public void addActiveProfile(String profile) Implements org.springframework.core.env.ConfigurableEnvironment.addActiveProfile. Doc from org.springframework.core.env.ConfigurableEnvironment.addActiveProfile. Add a profile to the current set of active profiles. Annotations @Override

addActiveProfile

back to summary

public void addActiveProfile(String profile)

Implements org.springframework.core.env.ConfigurableEnvironment.addActiveProfile.

Doc from org.springframework.core.env.ConfigurableEnvironment.addActiveProfile.

Add a profile to the current set of active profiles.

Annotations

@Override

containsProperty back to summary

containsProperty	back to summary
public boolean containsProperty(String key) Implements org.springframework.core.env.PropertyResolver.containsProperty. Doc from org.springframework.core.env.PropertyResolver.containsProperty. Return whether the given property key is available for resolution, i.e. if the value for the given key is not `null`. Annotations @Override

public boolean containsProperty(String key)

Implements org.springframework.core.env.PropertyResolver.containsProperty.

Doc from org.springframework.core.env.PropertyResolver.containsProperty.

Return whether the given property key is available for resolution, i.e. if the value for the given key is not null.

Annotations

@Override

createPropertyResolver back to summary

createPropertyResolver	back to summary
protected ConfigurablePropertyResolver createPropertyResolver(MutablePropertySources propertySources) Factory method used to create the `ConfigurablePropertyResolver` instance used by the Environment. Since 5.3.4 See Also `getPropertyResolver()`

protected ConfigurablePropertyResolver createPropertyResolver(MutablePropertySources propertySources)

Factory method used to create the ConfigurablePropertyResolver instance used by the Environment.

Since: 5.3.4
See Also: getPropertyResolver()

customizePropertySources back to summary

customizePropertySources	back to summary
protected void customizePropertySources(MutablePropertySources propertySources) Customize the set of `PropertySource` objects to be searched by this `Environment` during calls to `getProperty(String)` and related methods. Subclasses that override this method are encouraged to add property sources using `MutablePropertySources#addLast(PropertySource)` such that further subclasses may call `super.customizePropertySources()` with predictable results. For example: public class Level1Environment extends AbstractEnvironment { @Override protected void customizePropertySources(MutablePropertySources propertySources) { super.customizePropertySources(propertySources); // no-op from base class propertySources.addLast(new PropertySourceA(...)); propertySources.addLast(new PropertySourceB(...)); } } public class Level2Environment extends Level1Environment { @Override protected void customizePropertySources(MutablePropertySources propertySources) { super.customizePropertySources(propertySources); // add all from superclass propertySources.addLast(new PropertySourceC(...)); propertySources.addLast(new PropertySourceD(...)); } } In this arrangement, properties will be resolved against sources A, B, C, D in that order. That is to say that property source "A" has precedence over property source "D". If the `Level2Environment` subclass wished to give property sources C and D higher precedence than A and B, it could simply call `super.customizePropertySources` after, rather than before adding its own: public class Level2Environment extends Level1Environment { @Override protected void customizePropertySources(MutablePropertySources propertySources) { propertySources.addLast(new PropertySourceC(...)); propertySources.addLast(new PropertySourceD(...)); super.customizePropertySources(propertySources); // add all from superclass } } The search order is now C, D, A, B as desired. Beyond these recommendations, subclasses may use any of the `add`, `remove`, or `replace` methods exposed by `MutablePropertySources` in order to create the exact arrangement of property sources desired. The base implementation registers no property sources. Note that clients of any `ConfigurableEnvironment` may further customize property sources via the `getPropertySources()` accessor, typically within an `ApplicationContextInitializer`. For example: ConfigurableEnvironment env = new StandardEnvironment(); env.getPropertySources().addLast(new PropertySourceX(...)); A warning about instance variable access Instance variables declared in subclasses and having default initial values should not* be accessed from within this method. Due to Java object creation lifecycle constraints, any initial value will not yet be assigned when this callback is invoked by the `AbstractEnvironment()` constructor, which may lead to a `NullPointerException` or other problems. If you need to access default values of instance variables, leave this method as a no-op and perform property source manipulation and instance variable access directly within the subclass constructor. Note that assigning values to instance variables is not problematic; it is only attempting to read default values that must be avoided. See Also `MutablePropertySources`, `PropertySourcesPropertyResolver`, `org.springframework.context.ApplicationContextInitializer`

protected void customizePropertySources(MutablePropertySources propertySources)

Customize the set of PropertySource objects to be searched by this Environment during calls to getProperty(String) and related methods.

Subclasses that override this method are encouraged to add property sources using MutablePropertySources#addLast(PropertySource) such that further subclasses may call super.customizePropertySources() with predictable results. For example:

public class Level1Environment extends AbstractEnvironment {
    @Override
    protected void customizePropertySources(MutablePropertySources propertySources) {
        super.customizePropertySources(propertySources); // no-op from base class
        propertySources.addLast(new PropertySourceA(...));
        propertySources.addLast(new PropertySourceB(...));
    }
}

public class Level2Environment extends Level1Environment {
    @Override
    protected void customizePropertySources(MutablePropertySources propertySources) {
        super.customizePropertySources(propertySources); // add all from superclass
        propertySources.addLast(new PropertySourceC(...));
        propertySources.addLast(new PropertySourceD(...));
    }
}

In this arrangement, properties will be resolved against sources A, B, C, D in that order. That is to say that property source "A" has precedence over property source "D". If the Level2Environment subclass wished to give property sources C and D higher precedence than A and B, it could simply call super.customizePropertySources after, rather than before adding its own:

public class Level2Environment extends Level1Environment {
    @Override
    protected void customizePropertySources(MutablePropertySources propertySources) {
        propertySources.addLast(new PropertySourceC(...));
        propertySources.addLast(new PropertySourceD(...));
        super.customizePropertySources(propertySources); // add all from superclass
    }
}

The search order is now C, D, A, B as desired.

Beyond these recommendations, subclasses may use any of the add*, remove, or replace methods exposed by MutablePropertySources in order to create the exact arrangement of property sources desired.

The base implementation registers no property sources.

Note that clients of any ConfigurableEnvironment may further customize property sources via the getPropertySources() accessor, typically within an ApplicationContextInitializer. For example:

ConfigurableEnvironment env = new StandardEnvironment();
env.getPropertySources().addLast(new PropertySourceX(...));

A warning about instance variable access

Instance variables declared in subclasses and having default initial values should not be accessed from within this method. Due to Java object creation lifecycle constraints, any initial value will not yet be assigned when this callback is invoked by the AbstractEnvironment() constructor, which may lead to a NullPointerException or other problems. If you need to access default values of instance variables, leave this method as a no-op and perform property source manipulation and instance variable access directly within the subclass constructor. Note that assigning values to instance variables is not problematic; it is only attempting to read default values that must be avoided.

See Also: MutablePropertySources, PropertySourcesPropertyResolver, org.springframework.context.ApplicationContextInitializer

doGetActiveProfiles back to summary

doGetActiveProfiles	back to summary
protected Set<String> doGetActiveProfiles() Return the set of active profiles as explicitly set through `setActiveProfiles` or if the current set of active profiles is empty, check for the presence of `doGetActiveProfilesProperty()` and assign its value to the set of active profiles. See Also `getActiveProfiles()`, `doGetActiveProfilesProperty()`

protected Set<String> doGetActiveProfiles()

Return the set of active profiles as explicitly set through setActiveProfiles or if the current set of active profiles is empty, check for the presence of doGetActiveProfilesProperty() and assign its value to the set of active profiles.

See Also: getActiveProfiles(), doGetActiveProfilesProperty()

doGetActiveProfilesProperty back to summary

doGetActiveProfilesProperty	back to summary
protected String doGetActiveProfilesProperty() Return the property value for the active profiles. Annotations @Nullable Since 5.3.4 See Also `ACTIVE_PROFILES_PROPERTY_NAME`

protected String doGetActiveProfilesProperty()

Return the property value for the active profiles.

Annotations

@Nullable

Since

5.3.4

See Also

ACTIVE_PROFILES_PROPERTY_NAME

doGetDefaultProfiles back to summary

doGetDefaultProfiles	back to summary
protected Set<String> doGetDefaultProfiles() Return the set of default profiles explicitly set via `setDefaultProfiles(String...)` or if the current set of default profiles consists only of reserved default profiles, then check for the presence of `doGetActiveProfilesProperty()` and assign its value (if any) to the set of default profiles. See Also `AbstractEnvironment()`, `getDefaultProfiles()`, `getReservedDefaultProfiles()`, `doGetDefaultProfilesProperty()`

protected Set<String> doGetDefaultProfiles()

Return the set of default profiles explicitly set via setDefaultProfiles(String...) or if the current set of default profiles consists only of reserved default profiles, then check for the presence of doGetActiveProfilesProperty() and assign its value (if any) to the set of default profiles.

See Also: AbstractEnvironment(), getDefaultProfiles(), getReservedDefaultProfiles(), doGetDefaultProfilesProperty()

doGetDefaultProfilesProperty back to summary

doGetDefaultProfilesProperty	back to summary
protected String doGetDefaultProfilesProperty() Return the property value for the default profiles. Annotations @Nullable Since 5.3.4 See Also `DEFAULT_PROFILES_PROPERTY_NAME`

protected String doGetDefaultProfilesProperty()

Return the property value for the default profiles.

Annotations

@Nullable

Since

5.3.4

See Also

DEFAULT_PROFILES_PROPERTY_NAME

getActiveProfiles back to summary

getActiveProfiles	back to summary
public String[] getActiveProfiles() Implements org.springframework.core.env.Environment.getActiveProfiles. Doc from org.springframework.core.env.Environment.getActiveProfiles. Return the set of profiles explicitly made active for this environment. Profiles are used for creating logical groupings of bean definitions to be registered conditionally, for example based on deployment environment. Profiles can be activated by setting "spring.profiles.active" as a system property or by calling `ConfigurableEnvironment#setActiveProfiles(String...)`. If no profiles have explicitly been specified as active, then any default profiles will automatically be activated. Annotations @Override

public String[] getActiveProfiles()

Implements org.springframework.core.env.Environment.getActiveProfiles.

Doc from org.springframework.core.env.Environment.getActiveProfiles.

Return the set of profiles explicitly made active for this environment. Profiles are used for creating logical groupings of bean definitions to be registered conditionally, for example based on deployment environment. Profiles can be activated by setting "spring.profiles.active" as a system property or by calling ConfigurableEnvironment#setActiveProfiles(String...).

If no profiles have explicitly been specified as active, then any default profiles will automatically be activated.

Annotations

@Override

getConversionService back to summary

getConversionService	back to summary
public ConfigurableConversionService getConversionService() Implements org.springframework.core.env.ConfigurablePropertyResolver.getConversionService. Doc from org.springframework.core.env.ConfigurablePropertyResolver.getConversionService. Return the `ConfigurableConversionService` used when performing type conversions on properties. The configurable nature of the returned conversion service allows for the convenient addition and removal of individual `Converter` instances: ConfigurableConversionService cs = env.getConversionService(); cs.addConverter(new FooConverter()); Annotations @Override

public ConfigurableConversionService getConversionService()

Implements org.springframework.core.env.ConfigurablePropertyResolver.getConversionService.

Doc from org.springframework.core.env.ConfigurablePropertyResolver.getConversionService.

Return the ConfigurableConversionService used when performing type conversions on properties.

The configurable nature of the returned conversion service allows for the convenient addition and removal of individual Converter instances:

ConfigurableConversionService cs = env.getConversionService();
cs.addConverter(new FooConverter());

Annotations

@Override

getDefaultProfiles	back to summary
public String[] getDefaultProfiles() Implements org.springframework.core.env.Environment.getDefaultProfiles. Doc from org.springframework.core.env.Environment.getDefaultProfiles. Return the set of profiles to be active by default when no active profiles have been set explicitly. Annotations @Override

getDefaultProfiles

back to summary

public String[] getDefaultProfiles()

Implements org.springframework.core.env.Environment.getDefaultProfiles.

Doc from org.springframework.core.env.Environment.getDefaultProfiles.

Return the set of profiles to be active by default when no active profiles have been set explicitly.

Annotations

@Override

getProperty back to summary

getProperty	back to summary
public String getProperty(String key) Implements org.springframework.core.env.PropertyResolver.getProperty. Doc from org.springframework.core.env.PropertyResolver.getProperty. Return the property value associated with the given key, or `null` if the key cannot be resolved. Parameters key:String the property name to resolve Annotations @Override @Nullable

public String getProperty(String key)

Implements org.springframework.core.env.PropertyResolver.getProperty.

Doc from org.springframework.core.env.PropertyResolver.getProperty.

Return the property value associated with the given key, or null if the key cannot be resolved.

Parameters

key:String: the property name to resolve

Annotations

@Override
@Nullable

getProperty back to summary

getProperty	back to summary
public String getProperty(String key, String defaultValue) Implements org.springframework.core.env.PropertyResolver.getProperty. Doc from org.springframework.core.env.PropertyResolver.getProperty. Return the property value associated with the given key, or `defaultValue` if the key cannot be resolved. Parameters key:String the property name to resolve defaultValue:String the default value to return if no value is found Annotations @Override

public String getProperty(String key, String defaultValue)

Implements org.springframework.core.env.PropertyResolver.getProperty.

Doc from org.springframework.core.env.PropertyResolver.getProperty.

Return the property value associated with the given key, or defaultValue if the key cannot be resolved.

Parameters

key:String: the property name to resolve
defaultValue:String: the default value to return if no value is found

Annotations

@Override

getProperty back to summary

getProperty	back to summary
public <T> T getProperty(String key, Class<T> targetType) Implements org.springframework.core.env.PropertyResolver.getProperty. Doc from org.springframework.core.env.PropertyResolver.getProperty. Return the property value associated with the given key, or `null` if the key cannot be resolved. Parameters key:String the property name to resolve targetType:Class<T> the expected type of the property value Annotations @Override @Nullable

public <T> T getProperty(String key, Class<T> targetType)

Implements org.springframework.core.env.PropertyResolver.getProperty.

Doc from org.springframework.core.env.PropertyResolver.getProperty.

Return the property value associated with the given key, or null if the key cannot be resolved.

Parameters

key:String: the property name to resolve
targetType:Class<T>: the expected type of the property value

Annotations

@Override
@Nullable

getProperty back to summary

getProperty	back to summary
public <T> T getProperty(String key, Class<T> targetType, T defaultValue) Implements org.springframework.core.env.PropertyResolver.getProperty. Doc from org.springframework.core.env.PropertyResolver.getProperty. Return the property value associated with the given key, or `defaultValue` if the key cannot be resolved. Parameters key:String the property name to resolve targetType:Class<T> the expected type of the property value defaultValue:T the default value to return if no value is found Annotations @Override

public <T> T getProperty(String key, Class<T> targetType, T defaultValue)

Implements org.springframework.core.env.PropertyResolver.getProperty.

Doc from org.springframework.core.env.PropertyResolver.getProperty.

Return the property value associated with the given key, or defaultValue if the key cannot be resolved.

Parameters

key:String: the property name to resolve
targetType:Class<T>: the expected type of the property value
defaultValue:T: the default value to return if no value is found

Annotations

@Override

getPropertyResolver back to summary

getPropertyResolver	back to summary
protected final ConfigurablePropertyResolver getPropertyResolver() Return the `ConfigurablePropertyResolver` being used by the `Environment`. Since 5.3.4 See Also `createPropertyResolver(MutablePropertySources)`

protected final ConfigurablePropertyResolver getPropertyResolver()

Return the ConfigurablePropertyResolver being used by the Environment.

Since: 5.3.4
See Also: createPropertyResolver(MutablePropertySources)

getPropertySources back to summary

getPropertySources	back to summary
public MutablePropertySources getPropertySources() Implements org.springframework.core.env.ConfigurableEnvironment.getPropertySources. Doc from org.springframework.core.env.ConfigurableEnvironment.getPropertySources. Return the `PropertySources` for this `Environment` in mutable form, allowing for manipulation of the set of `PropertySource` objects that should be searched when resolving properties against this `Environment` object. The various `MutablePropertySources` methods such as `addFirst`, `addLast`, `addBefore` and `addAfter` allow 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. Annotations @Override

public MutablePropertySources getPropertySources()

Implements org.springframework.core.env.ConfigurableEnvironment.getPropertySources.

Doc from org.springframework.core.env.ConfigurableEnvironment.getPropertySources.

Return the PropertySources for this Environment in mutable form, allowing for manipulation of the set of PropertySource objects that should be searched when resolving properties against this Environment object. The various MutablePropertySources methods such as addFirst, addLast, addBefore and addAfter allow 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.

Annotations

@Override

getRequiredProperty back to summary

getRequiredProperty	back to summary
public String getRequiredProperty(String key) throws IllegalStateException Implements org.springframework.core.env.PropertyResolver.getRequiredProperty. Doc from org.springframework.core.env.PropertyResolver.getRequiredProperty. Return the property value associated with the given key (never `null`). Annotations @Override Exceptions IllegalStateException: if the key cannot be resolved

public String getRequiredProperty(String key) throws IllegalStateException

Implements org.springframework.core.env.PropertyResolver.getRequiredProperty.

Doc from org.springframework.core.env.PropertyResolver.getRequiredProperty.

Return the property value associated with the given key (never null).

Annotations

@Override

Exceptions

IllegalStateException:: if the key cannot be resolved

getRequiredProperty back to summary

getRequiredProperty	back to summary
public <T> T getRequiredProperty(String key, Class<T> targetType) throws IllegalStateException Implements org.springframework.core.env.PropertyResolver.getRequiredProperty. Doc from org.springframework.core.env.PropertyResolver.getRequiredProperty. Return the property value associated with the given key, converted to the given targetType (never `null`). Annotations @Override Exceptions IllegalStateException: if the given key cannot be resolved

public <T> T getRequiredProperty(String key, Class<T> targetType) throws IllegalStateException

Implements org.springframework.core.env.PropertyResolver.getRequiredProperty.

Doc from org.springframework.core.env.PropertyResolver.getRequiredProperty.

Return the property value associated with the given key, converted to the given targetType (never null).

Annotations

@Override

Exceptions

IllegalStateException:: if the given key cannot be resolved

getReservedDefaultProfiles back to summary

getReservedDefaultProfiles	back to summary
protected Set<String> getReservedDefaultProfiles() Return the set of reserved default profile names. This implementation returns default. Subclasses may override in order to customize the set of reserved names. See Also `RESERVED_DEFAULT_PROFILE_NAME`, `doGetDefaultProfiles()`

protected Set<String> getReservedDefaultProfiles()

Return the set of reserved default profile names. This implementation returns default. Subclasses may override in order to customize the set of reserved names.

See Also: RESERVED_DEFAULT_PROFILE_NAME, doGetDefaultProfiles()

getSystemEnvironment back to summary

getSystemEnvironment	back to summary
public Map<String, Object> getSystemEnvironment() Implements org.springframework.core.env.ConfigurableEnvironment.getSystemEnvironment. Doc from org.springframework.core.env.ConfigurableEnvironment.getSystemEnvironment. Return the value of `System#getenv()`. Note that most `Environment` implementations will include this system environment map as a default `PropertySource` to be searched. Therefore, it is recommended that this method not be used directly unless bypassing other property sources is expressly intended. Annotations @Override @SuppressWarnings:rawtypes, unchecked

public Map<String, Object> getSystemEnvironment()

Implements org.springframework.core.env.ConfigurableEnvironment.getSystemEnvironment.

Doc from org.springframework.core.env.ConfigurableEnvironment.getSystemEnvironment.

Return the value of System#getenv().

Note that most Environment implementations will include this system environment map as a default PropertySource to be searched. Therefore, it is recommended that this method not be used directly unless bypassing other property sources is expressly intended.

Annotations

@Override
@SuppressWarnings:rawtypes, unchecked

getSystemProperties back to summary

getSystemProperties	back to summary
public Map<String, Object> getSystemProperties() Implements org.springframework.core.env.ConfigurableEnvironment.getSystemProperties. Doc from org.springframework.core.env.ConfigurableEnvironment.getSystemProperties. Return the value of `System#getProperties()`. Note that most `Environment` implementations will include this system properties map as a default `PropertySource` to be searched. Therefore, it is recommended that this method not be used directly unless bypassing other property sources is expressly intended. Annotations @Override @SuppressWarnings:rawtypes, unchecked

public Map<String, Object> getSystemProperties()

Implements org.springframework.core.env.ConfigurableEnvironment.getSystemProperties.

Doc from org.springframework.core.env.ConfigurableEnvironment.getSystemProperties.

Return the value of System#getProperties().

Note that most Environment implementations will include this system properties map as a default PropertySource to be searched. Therefore, it is recommended that this method not be used directly unless bypassing other property sources is expressly intended.

Annotations

@Override
@SuppressWarnings:rawtypes, unchecked

isProfileActive back to summary

isProfileActive	back to summary
protected boolean isProfileActive(String profile) Return whether the given profile is active, or if active profiles are empty whether the profile should be active by default. Exceptions IllegalArgumentException: per `validateProfile(String)`

protected boolean isProfileActive(String profile)

Return whether the given profile is active, or if active profiles are empty whether the profile should be active by default.

Exceptions

IllegalArgumentException:: per validateProfile(String)

merge back to summary

merge	back to summary
public void merge(ConfigurableEnvironment parent) Implements org.springframework.core.env.ConfigurableEnvironment.merge. Doc from org.springframework.core.env.ConfigurableEnvironment.merge. 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 `PropertySource` instance 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 `merge` will not be reflected in the child. Therefore, care should be taken to configure parent property sources and profile information prior to calling `merge`. Parameters parent:ConfigurableEnvironment the environment to merge with Annotations @Override

public void merge(ConfigurableEnvironment parent)

Implements org.springframework.core.env.ConfigurableEnvironment.merge.

Doc from org.springframework.core.env.ConfigurableEnvironment.merge.

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 PropertySource instance 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 merge will not be reflected in the child. Therefore, care should be taken to configure parent property sources and profile information prior to calling merge.

Parameters

parent:ConfigurableEnvironment: the environment to merge with

Annotations

@Override

resolvePlaceholders back to summary

resolvePlaceholders	back to summary
public String resolvePlaceholders(String text) Implements org.springframework.core.env.PropertyResolver.resolvePlaceholders. Doc from org.springframework.core.env.PropertyResolver.resolvePlaceholders. Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by `getProperty`. Unresolvable placeholders with no default value are ignored and passed through unchanged. Parameters text:String the String to resolve Returns:String the resolved String (never `null`) Annotations @Override

public String resolvePlaceholders(String text)

Implements org.springframework.core.env.PropertyResolver.resolvePlaceholders.

Doc from org.springframework.core.env.PropertyResolver.resolvePlaceholders.

Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by getProperty. Unresolvable placeholders with no default value are ignored and passed through unchanged.

Parameters

text:String: the String to resolve

Returns:String

the resolved String (never null)

Annotations

@Override

resolveRequiredPlaceholders back to summary

resolveRequiredPlaceholders	back to summary
public String resolveRequiredPlaceholders(String text) throws IllegalArgumentException Implements org.springframework.core.env.PropertyResolver.resolveRequiredPlaceholders. Doc from org.springframework.core.env.PropertyResolver.resolveRequiredPlaceholders. Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by `getProperty`. Unresolvable placeholders with no default value will cause an IllegalArgumentException to be thrown. Returns:String the resolved String (never `null`) Annotations @Override Exceptions IllegalArgumentException: if given text is `null` or if any placeholders are unresolvable

public String resolveRequiredPlaceholders(String text) throws IllegalArgumentException

Implements org.springframework.core.env.PropertyResolver.resolveRequiredPlaceholders.

Doc from org.springframework.core.env.PropertyResolver.resolveRequiredPlaceholders.

Returns:String

the resolved String (never null)

Annotations

@Override

Exceptions

IllegalArgumentException:: if given text is null or if any placeholders are unresolvable

setActiveProfiles back to summary

setActiveProfiles	back to summary
public void setActiveProfiles(String... profiles) Implements org.springframework.core.env.ConfigurableEnvironment.setActiveProfiles. Doc from org.springframework.core.env.ConfigurableEnvironment.setActiveProfiles. 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` to add a profile while preserving the existing set. Annotations @Override

public void setActiveProfiles(String... profiles)

Implements org.springframework.core.env.ConfigurableEnvironment.setActiveProfiles.

Doc from org.springframework.core.env.ConfigurableEnvironment.setActiveProfiles.

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 to add a profile while preserving the existing set.

Annotations

@Override

setConversionService back to summary

setConversionService	back to summary
public void setConversionService(ConfigurableConversionService conversionService) Implements org.springframework.core.env.ConfigurablePropertyResolver.setConversionService. Doc from org.springframework.core.env.ConfigurablePropertyResolver.setConversionService. Set the `ConfigurableConversionService` to be used when performing type conversions on properties. Note as an alternative to fully replacing the `ConversionService`, consider adding or removing individual `Converter` instances by drilling into `getConversionService()` and calling methods such as `#addConverter`. Annotations @Override

public void setConversionService(ConfigurableConversionService conversionService)

Implements org.springframework.core.env.ConfigurablePropertyResolver.setConversionService.

Doc from org.springframework.core.env.ConfigurablePropertyResolver.setConversionService.

Set the ConfigurableConversionService to be used when performing type conversions on properties.

Note

as an alternative to fully replacing the ConversionService, consider adding or removing individual Converter instances by drilling into getConversionService() and calling methods such as #addConverter.

Annotations

@Override

setDefaultProfiles back to summary

setDefaultProfiles	back to summary
public void setDefaultProfiles(String... profiles) Implements org.springframework.core.env.ConfigurableEnvironment.setDefaultProfiles. Specify the set of profiles to be made active by default if no other profiles are explicitly made active through `setActiveProfiles`. Calling this method removes overrides any reserved default profiles that may have been added during construction of the environment. Annotations @Override See Also `AbstractEnvironment()`, `getReservedDefaultProfiles()`

public void setDefaultProfiles(String... profiles)

Implements org.springframework.core.env.ConfigurableEnvironment.setDefaultProfiles.

Specify the set of profiles to be made active by default if no other profiles are explicitly made active through setActiveProfiles.

Calling this method removes overrides any reserved default profiles that may have been added during construction of the environment.

Annotations

@Override

setIgnoreUnresolvableNestedPlaceholders back to summary

setIgnoreUnresolvableNestedPlaceholders	back to summary
public void setIgnoreUnresolvableNestedPlaceholders(boolean ignoreUnresolvableNestedPlaceholders) Implements org.springframework.core.env.ConfigurablePropertyResolver.setIgnoreUnresolvableNestedPlaceholders. Doc from org.springframework.core.env.ConfigurablePropertyResolver.setIgnoreUnresolvableNestedPlaceholders. Set whether to throw an exception when encountering an unresolvable placeholder nested within the value of a given property. A `false` value indicates strict resolution, i.e. that an exception will be thrown. A `true` value indicates that unresolvable nested placeholders should be passed through in their unresolved ${...} form. Implementations of `getProperty(String)` and its variants must inspect the value set here to determine correct behavior when property values contain unresolvable placeholders. Annotations @Override

public void setIgnoreUnresolvableNestedPlaceholders(boolean ignoreUnresolvableNestedPlaceholders)

Implements org.springframework.core.env.ConfigurablePropertyResolver.setIgnoreUnresolvableNestedPlaceholders.

Doc from org.springframework.core.env.ConfigurablePropertyResolver.setIgnoreUnresolvableNestedPlaceholders.

Set whether to throw an exception when encountering an unresolvable placeholder nested within the value of a given property. A false value indicates strict resolution, i.e. that an exception will be thrown. A true value indicates that unresolvable nested placeholders should be passed through in their unresolved ${...} form.

Implementations of getProperty(String) and its variants must inspect the value set here to determine correct behavior when property values contain unresolvable placeholders.

Annotations

@Override

setPlaceholderPrefix	back to summary
public void setPlaceholderPrefix(String placeholderPrefix) Implements org.springframework.core.env.ConfigurablePropertyResolver.setPlaceholderPrefix. Doc from org.springframework.core.env.ConfigurablePropertyResolver.setPlaceholderPrefix. Set the prefix that placeholders replaced by this resolver must begin with. Annotations @Override

setPlaceholderPrefix

back to summary

public void setPlaceholderPrefix(String placeholderPrefix)

Implements org.springframework.core.env.ConfigurablePropertyResolver.setPlaceholderPrefix.

Doc from org.springframework.core.env.ConfigurablePropertyResolver.setPlaceholderPrefix.

Set the prefix that placeholders replaced by this resolver must begin with.

Annotations

@Override

setPlaceholderSuffix	back to summary
public void setPlaceholderSuffix(String placeholderSuffix) Implements org.springframework.core.env.ConfigurablePropertyResolver.setPlaceholderSuffix. Doc from org.springframework.core.env.ConfigurablePropertyResolver.setPlaceholderSuffix. Set the suffix that placeholders replaced by this resolver must end with. Annotations @Override

setPlaceholderSuffix

back to summary

public void setPlaceholderSuffix(String placeholderSuffix)

Implements org.springframework.core.env.ConfigurablePropertyResolver.setPlaceholderSuffix.

Doc from org.springframework.core.env.ConfigurablePropertyResolver.setPlaceholderSuffix.

Set the suffix that placeholders replaced by this resolver must end with.

Annotations

@Override

setRequiredProperties back to summary

setRequiredProperties	back to summary
public void setRequiredProperties(String... requiredProperties) Implements org.springframework.core.env.ConfigurablePropertyResolver.setRequiredProperties. Doc from org.springframework.core.env.ConfigurablePropertyResolver.setRequiredProperties. Specify which properties must be present, to be verified by `validateRequiredProperties()`. Annotations @Override

public void setRequiredProperties(String... requiredProperties)

Implements org.springframework.core.env.ConfigurablePropertyResolver.setRequiredProperties.

Doc from org.springframework.core.env.ConfigurablePropertyResolver.setRequiredProperties.

Specify which properties must be present, to be verified by validateRequiredProperties().

Annotations

@Override

setValueSeparator back to summary

setValueSeparator	back to summary
public void setValueSeparator(String valueSeparator) Implements org.springframework.core.env.ConfigurablePropertyResolver.setValueSeparator. Doc from org.springframework.core.env.ConfigurablePropertyResolver.setValueSeparator. Specify the separating character between the placeholders replaced by this resolver and their associated default value, or `null` if no such special character should be processed as a value separator. Annotations @Override

public void setValueSeparator(String valueSeparator)

Implements org.springframework.core.env.ConfigurablePropertyResolver.setValueSeparator.

Doc from org.springframework.core.env.ConfigurablePropertyResolver.setValueSeparator.

Specify the separating character between the placeholders replaced by this resolver and their associated default value, or null if no such special character should be processed as a value separator.

Annotations

@Override

suppressGetenvAccess back to summary

protected boolean suppressGetenvAccess()

Determine whether to suppress System#getenv()/System#getenv(String) access for the purposes of getSystemEnvironment().

If this method returns true, an empty dummy Map will be used instead of the regular system environment Map, never even trying to call getenv and therefore avoiding security manager warnings (if any).

The default implementation checks for the "spring.getenv.ignore" system property, returning true if its value equals "true" in any case.

See Also: IGNORE_GETENV_PROPERTY_NAME, SpringProperties#getFlag

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

validateProfile back to summary

protected void validateProfile(String profile)

Validate the given profile, called internally prior to adding to the set of active or default profiles.

Subclasses may override to impose further restrictions on profile syntax.

Exceptions

IllegalArgumentException:: if the profile is null, empty, whitespace-only or begins with the profile NOT operator (!).

validateRequiredProperties back to summary

public void validateRequiredProperties() throws MissingRequiredPropertiesException

Implements org.springframework.core.env.ConfigurablePropertyResolver.validateRequiredProperties.

Doc from org.springframework.core.env.ConfigurablePropertyResolver.validateRequiredProperties.

Validate that each of the properties specified by setRequiredProperties is present and resolves to a non-null value.

Annotations

@Override

Exceptions

MissingRequiredPropertiesException:: if any of the required properties are not resolvable.

public abstract Class AbstractEnvironment

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

A warning about instance variable access