public class

ServletContextPropertyPlaceholderConfigurer

extends PropertyPlaceholderConfigurer
implements ServletContextAware

java.lang.Object
↳	org.springframework.core.io.support.PropertiesLoaderSupport
	↳	org.springframework.beans.factory.config.PropertyResourceConfigurer
		↳	org.springframework.beans.factory.config.PlaceholderConfigurerSupport
			↳	org.springframework.beans.factory.config.PropertyPlaceholderConfigurer
				↳	org.springframework.web.context.support.ServletContextPropertyPlaceholderConfigurer

This class is deprecated.
in Spring 3.1 in favor of PropertySourcesPlaceholderConfigurer in conjunction with DefaultWebEnvironment.

Class Overview

Subclass of PropertyPlaceholderConfigurer that resolves placeholders as ServletContext init parameters (that is, web.xml context-param entries).

Can be combined with "locations" and/or "properties" values in addition to web.xml context-params. Alternatively, can be defined without local properties, to resolve all placeholders as web.xml context-params (or JVM system properties).

If a placeholder could not be resolved against the provided local properties within the application, this configurer will fall back to ServletContext parameters. Can also be configured to let ServletContext init parameters override local properties (contextOverride=true).

Optionally supports searching for ServletContext attributes: If turned on, an otherwise unresolvable placeholder will matched against the corresponding ServletContext attribute, using its stringified value if found. This can be used to feed dynamic values into Spring's placeholder resolution.

If not running within a WebApplicationContext (or any other context that is able to satisfy the ServletContextAware callback), this class will behave like the default PropertyPlaceholderConfigurer. This allows for keeping ServletContextPropertyPlaceholderConfigurer definitions in test suites.

Summary

[Expand]

Inherited Constants

From class org.springframework.beans.factory.config.PropertyPlaceholderConfigurer

From class org.springframework.beans.factory.config.PlaceholderConfigurerSupport

From class org.springframework.core.io.support.PropertiesLoaderSupport

From interface org.springframework.core.Ordered

[Expand]

Inherited Fields

From class org.springframework.beans.factory.config.PlaceholderConfigurerSupport

From class org.springframework.core.io.support.PropertiesLoaderSupport

Public Constructors
	ServletContextPropertyPlaceholderConfigurer()

Public Methods
void	setContextOverride(boolean contextOverride) Set whether ServletContext init parameters (and optionally also ServletContext attributes) should override local properties within the application.
void	setSearchContextAttributes(boolean searchContextAttributes) Set whether to search for matching a ServletContext attribute before checking a ServletContext init parameter.
void	setServletContext(ServletContext servletContext) Set the ServletContext to resolve placeholders against.

Protected Methods
String	resolvePlaceholder(String placeholder, Properties props) Resolve the given placeholder using the given properties.
String	resolvePlaceholder(String placeholder, ServletContext servletContext, boolean searchContextAttributes) Resolves the given placeholder using the init parameters and optionally also the attributes of the given ServletContext.

[Expand]

Inherited Methods

From class org.springframework.beans.factory.config.PropertyPlaceholderConfigurer

String	parseStringValue(String strVal, Properties props, Set<?> visitedPlaceholders) This method is deprecated. as of Spring 3.0, in favor of using `resolvePlaceholder(String, Properties)` with `PropertyPlaceholderHelper`. Only retained for compatibility with Spring 2.5 extensions.
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.
String	resolvePlaceholder(String placeholder, Properties props) Resolve the given placeholder using the given properties.
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.
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.

From class org.springframework.beans.factory.config.PlaceholderConfigurerSupport

void	doProcessProperties(ConfigurableListableBeanFactory beanFactoryToProcess, StringValueResolver valueResolver)
void	setBeanFactory(BeanFactory beanFactory) Only necessary to check that we're not parsing our own bean definition, to avoid failing on unresolvable placeholders in properties file locations.
void	setBeanName(String beanName) Only necessary to check that we're not parsing our own bean definition, to avoid failing on unresolvable placeholders in properties file locations.
void	setIgnoreUnresolvablePlaceholders(boolean ignoreUnresolvablePlaceholders) Set whether to ignore unresolvable placeholders.
void	setNullValue(String nullValue) Set a value that should be treated as `null` when resolved as a placeholder value: e.g.
void	setPlaceholderPrefix(String placeholderPrefix) Set the prefix that a placeholder string starts with.
void	setPlaceholderSuffix(String placeholderSuffix) Set the suffix that a placeholder string ends with.
void	setValueSeparator(String valueSeparator) Specify the separating character between the placeholder variable and the associated default value, or `null` if no such special character should be processed as a value separator.

From class org.springframework.beans.factory.config.PropertyResourceConfigurer

From class org.springframework.core.io.support.PropertiesLoaderSupport

void	loadProperties(Properties props) Load properties into the given instance.
Properties	mergeProperties() Return a merged Properties instance containing both the loaded properties and properties set on this FactoryBean.
void	setFileEncoding(String encoding) Set the encoding to use for parsing properties files.
void	setIgnoreResourceNotFound(boolean ignoreResourceNotFound) Set if failure to find the property resource should be ignored.
void	setLocalOverride(boolean localOverride) Set whether local properties override properties from files.
void	setLocation(Resource location) Set a location of a properties file to be loaded.
void	setLocations(Resource[] locations) Set locations of properties files to be loaded.
void	setProperties(Properties properties) Set local properties, e.g.
void	setPropertiesArray(Properties[] propertiesArray) Set local properties, e.g.
void	setPropertiesPersister(PropertiesPersister propertiesPersister) Set the PropertiesPersister to use for parsing properties files.

From class java.lang.Object

From interface org.springframework.beans.factory.BeanFactoryAware

From interface org.springframework.beans.factory.BeanNameAware

From interface org.springframework.beans.factory.config.BeanFactoryPostProcessor

From interface org.springframework.core.Ordered

From interface org.springframework.web.context.ServletContextAware

Public Constructors

public ServletContextPropertyPlaceholderConfigurer ()

Public Methods

public void setContextOverride (boolean contextOverride)

Set whether ServletContext init parameters (and optionally also ServletContext attributes) should override local properties within the application. Default is "false": ServletContext settings serve as fallback.

Note that system properties will still override ServletContext settings, if the system properties mode is set to "SYSTEM_PROPERTIES_MODE_OVERRIDE".

public void setSearchContextAttributes (boolean searchContextAttributes)

Set whether to search for matching a ServletContext attribute before checking a ServletContext init parameter. Default is "false": only checking init parameters.

If turned on, the configurer will look for a ServletContext attribute with the same name as the placeholder, and use its stringified value if found. Exposure of such ServletContext attributes can be used to dynamically override init parameters defined in web.xml, for example in a custom context listener.

public void setServletContext (ServletContext servletContext)

Set the ServletContext to resolve placeholders against. Will be auto-populated when running in a WebApplicationContext.

If not set, this configurer will simply not resolve placeholders against the ServletContext: It will effectively behave like a plain PropertyPlaceholderConfigurer in such a scenario.

Parameters

servletContext	ServletContext object to be used by this object

Protected Methods

protected String resolvePlaceholder (String placeholder, Properties props)

Resolve the given placeholder using the given properties. The default implementation simply checks for a corresponding property key.

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.

Parameters

placeholder	the placeholder to resolve
props	the merged properties of this configurer

Returns

the resolved value, of null if none

protected String resolvePlaceholder (String placeholder, ServletContext servletContext, boolean searchContextAttributes)

Resolves the given placeholder using the init parameters and optionally also the attributes of the given ServletContext.

Default implementation checks ServletContext attributes before init parameters. Can be overridden to customize this behavior, potentially also applying specific naming patterns for parameters and/or attributes (instead of using the exact placeholder name).

Parameters

placeholder	the placeholder to resolve
servletContext	the ServletContext to check
searchContextAttributes	whether to search for a matching ServletContext attribute

Returns

the resolved value, of null if none

Classes

ServletContextPropertyPlaceholderConfigurer

Class Overview

See Also

Summary

Public Constructors

public ServletContextPropertyPlaceholderConfigurer ()

Public Methods

public void setContextOverride (boolean contextOverride)

See Also

public void setSearchContextAttributes (boolean searchContextAttributes)

See Also

public void setServletContext (ServletContext servletContext)

Parameters

Protected Methods

protected String resolvePlaceholder (String placeholder, Properties props)

Parameters

Returns

protected String resolvePlaceholder (String placeholder, ServletContext servletContext, boolean searchContextAttributes)

Parameters

Returns

See Also