public class PropertyPlaceholderConfigurer extends PlaceholderConfigurerSupport
PlaceholderConfigurerSupport
subclass that resolves ${...} placeholders
against local
properties
and/or system properties
and environment variables.
As of Spring 3.1, PropertySourcesPlaceholderConfigurer
should be used preferentially over this implementation; it is
more flexible through taking advantage of the Environment
and
PropertySource
mechanisms also made available in Spring 3.1.
PropertyPlaceholderConfigurer
is still appropriate for use when:
spring-context
module is not available (i.e., one is using Spring's
BeanFactory
API as opposed to ApplicationContext
).
"systemPropertiesMode"
and/or
"systemPropertiesModeName"
properties. Users are encouraged to move
away from using these settings, and rather configure property source search order through the container's
Environment
; however, exact preservation of functionality may be maintained by continuing to
use PropertyPlaceholderConfigurer
.
Prior to Spring 3.1, the <context:property-placeholder/>
namespace element
registered an instance of PropertyPlaceholderConfigurer
. It will still do so if
using the spring-context-3.0.xsd
definition of the namespace. That is, you can preserve
registration of PropertyPlaceholderConfigurer
through the namespace, even if using Spring 3.1;
simply do not update your xsi:schemaLocation
and continue using the 3.0 XSD.
setSystemPropertiesModeName(java.lang.String)
,
PlaceholderConfigurerSupport
,
PropertyOverrideConfigurer
,
PropertySourcesPlaceholderConfigurer
Modifier and Type | Field and Description |
---|---|
static int |
SYSTEM_PROPERTIES_MODE_FALLBACK
Check system properties if not resolvable in the specified properties.
|
static int |
SYSTEM_PROPERTIES_MODE_NEVER
Never check system properties.
|
static int |
SYSTEM_PROPERTIES_MODE_OVERRIDE
Check system properties first, before trying the specified properties.
|
DEFAULT_PLACEHOLDER_PREFIX, DEFAULT_PLACEHOLDER_SUFFIX, DEFAULT_VALUE_SEPARATOR, ignoreUnresolvablePlaceholders, nullValue, placeholderPrefix, placeholderSuffix, trimValues, valueSeparator
localOverride, localProperties, logger
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor and Description |
---|
PropertyPlaceholderConfigurer() |
Modifier and Type | Method and Description |
---|---|
protected String |
parseStringValue(String strVal,
Properties props,
Set<?> visitedPlaceholders)
Deprecated.
as of Spring 3.0, in favor of using
resolvePlaceholder(java.lang.String, java.util.Properties, int)
with PropertyPlaceholderHelper .
Only retained for compatibility with Spring 2.5 extensions. |
protected void |
processProperties(ConfigurableListableBeanFactory beanFactoryToProcess,
Properties props)
Visit each bean definition in the given bean factory and attempt to replace ${...} property
placeholders with values from the given properties.
|
protected String |
resolvePlaceholder(String placeholder,
Properties props)
Resolve the given placeholder using the given properties.
|
protected String |
resolvePlaceholder(String placeholder,
Properties props,
int systemPropertiesMode)
Resolve the given placeholder using the given properties, performing
a system properties check according to the given mode.
|
protected String |
resolveSystemProperty(String key)
Resolve the given key as JVM system property, and optionally also as
system environment variable if no matching system property has been found.
|
void |
setSearchSystemEnvironment(boolean searchSystemEnvironment)
Set whether to search for a matching system environment variable
if no matching system property has been found.
|
void |
setSystemPropertiesMode(int systemPropertiesMode)
Set how to check system properties: as fallback, as override, or never.
|
void |
setSystemPropertiesModeName(String constantName)
Set the system property mode by the name of the corresponding constant,
e.g.
|
doProcessProperties, setBeanFactory, setBeanName, setIgnoreUnresolvablePlaceholders, setNullValue, setPlaceholderPrefix, setPlaceholderSuffix, setTrimValues, setValueSeparator
convertProperties, convertProperty, convertPropertyValue, getOrder, postProcessBeanFactory, setOrder
loadProperties, mergeProperties, setFileEncoding, setIgnoreResourceNotFound, setLocalOverride, setLocation, setLocations, setProperties, setPropertiesArray, setPropertiesPersister
public static final int SYSTEM_PROPERTIES_MODE_NEVER
public static final int SYSTEM_PROPERTIES_MODE_FALLBACK
public static final int SYSTEM_PROPERTIES_MODE_OVERRIDE
public void setSystemPropertiesModeName(String constantName) throws IllegalArgumentException
constantName
- name of the constantIllegalArgumentException
- if an invalid constant was specifiedsetSystemPropertiesMode(int)
public void setSystemPropertiesMode(int systemPropertiesMode)
The default is "fallback": If not being able to resolve a placeholder with the specified properties, a system property will be tried. "override" will check for a system property first, before trying the specified properties. "never" will not check system properties at all.
public void setSearchSystemEnvironment(boolean searchSystemEnvironment)
Default is "true". Switch this setting off to never resolve placeholders against system environment variables. Note that it is generally recommended to pass external values in as JVM system properties: This can easily be achieved in a startup script, even for existing environment variables.
NOTE: Access to environment variables does not work on the
Sun VM 1.4, where the corresponding System.getenv(java.lang.String)
support was
disabled - before it eventually got re-enabled for the Sun VM 1.5.
Please upgrade to 1.5 (or higher) if you intend to rely on the
environment variable support.
protected String resolvePlaceholder(String placeholder, Properties props, int systemPropertiesMode)
The default implementation delegates to resolvePlaceholder
(placeholder, props)
before/after the system properties check.
Subclasses can override this for custom resolution strategies, including customized points for the system properties check.
placeholder
- the placeholder to resolveprops
- the merged properties of this configurersystemPropertiesMode
- the system properties mode,
according to the constants in this classsetSystemPropertiesMode(int)
,
System.getProperty(java.lang.String)
,
resolvePlaceholder(String, java.util.Properties)
protected String resolvePlaceholder(String placeholder, Properties props)
Subclasses can override this for customized placeholder-to-key mappings or custom resolution strategies, possibly just using the given properties as fallback.
Note that system properties will still be checked before respectively after this method is invoked, according to the system properties mode.
placeholder
- the placeholder to resolveprops
- the merged properties of this configurernull
if nonesetSystemPropertiesMode(int)
protected String resolveSystemProperty(String key)
key
- the placeholder to resolve as system property keynull
if not foundsetSearchSystemEnvironment(boolean)
,
System.getProperty(String)
,
System.getenv(String)
protected void processProperties(ConfigurableListableBeanFactory beanFactoryToProcess, Properties props) throws BeansException
processProperties
in class PropertyResourceConfigurer
beanFactoryToProcess
- the BeanFactory used by the application contextprops
- the Properties to applyBeansException
- in case of errors@Deprecated protected String parseStringValue(String strVal, Properties props, Set<?> visitedPlaceholders)
resolvePlaceholder(java.lang.String, java.util.Properties, int)
with PropertyPlaceholderHelper
.
Only retained for compatibility with Spring 2.5 extensions.strVal
- the String value to parseprops
- the Properties to resolve placeholders againstvisitedPlaceholders
- the placeholders that have already been visited
during the current resolution attempt (ignored in this version of the code)