PropertyOverrideConfigurer

Class Overview

Property resource configurer that overrides bean property values in an application context definition. It pushes values from a properties file into bean definitions.

Configuration lines are expected to be of the following form:

beanName.property=value

Example properties file:

dataSource.driverClassName=com.mysql.jdbc.Driver
 dataSource.url=jdbc:mysql:mydb

In contrast to PropertyPlaceholderConfigurer, the original definition can have default values or no values at all for such bean properties. If an overriding properties file does not have an entry for a certain bean property, the default context definition is used.

Note that the context definition is not aware of being overridden; so this is not immediately obvious when looking at the XML definition file. Furthermore, note that specified override values are always literal values; they are not translated into bean references. This also applies when the original value in the XML bean definition specifies a bean reference.

In case of multiple PropertyOverrideConfigurers that define different values for the same bean property, the last one will win (due to the overriding mechanism).

Property values can be converted after reading them in, through overriding the convertPropertyValue method. For example, encrypted values can be detected and decrypted accordingly before processing them.

Summary

Constants
String	DEFAULT_BEAN_NAME_SEPARATOR

[Expand] Inherited Constants
From class org.springframework.core.io.support.PropertiesLoaderSupport String XML_FILE_EXTENSION
From interface org.springframework.core.Ordered int HIGHEST_PRECEDENCE Useful constant for the highest precedence value. int LOWEST_PRECEDENCE Useful constant for the lowest precedence value.

[Expand] Inherited Fields
From class org.springframework.core.io.support.PropertiesLoaderSupport protected boolean localOverride protected Properties[] localProperties protected final Log logger Logger available to subclasses

Public Constructors
	PropertyOverrideConfigurer()

Public Methods
boolean	hasPropertyOverridesFor(String beanName) Were there overrides for this bean? Only valid after processing has occurred at least once.
void	setBeanNameSeparator(String beanNameSeparator) Set the separator to expect between bean name and property path.
void	setIgnoreInvalidKeys(boolean ignoreInvalidKeys) Set whether to ignore invalid keys.

Protected Methods
void	applyPropertyValue(ConfigurableListableBeanFactory factory, String beanName, String property, String value) Apply the given property value to the corresponding bean.
void	processKey(ConfigurableListableBeanFactory factory, String key, String value) Process the given key as 'beanName.property' entry.
void	processProperties(ConfigurableListableBeanFactory beanFactory, Properties props) Apply the given Properties to the given BeanFactory.

[Expand] Inherited Methods
From class org.springframework.beans.factory.config.PropertyResourceConfigurer void convertProperties(Properties props) Convert the given merged properties, converting property values if necessary. String convertProperty(String propertyName, String propertyValue) Convert the given property from the properties source to the value which should be applied. String convertPropertyValue(String originalValue) Convert the given property value from the properties source to the value which should be applied. int getOrder() Return the order value of this object, with a higher value meaning greater in terms of sorting. void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) Merge, convert and process properties against the given bean factory. abstract void processProperties(ConfigurableListableBeanFactory beanFactory, Properties props) Apply the given Properties to the given BeanFactory. void setOrder(int order) Set the order value of this object for sorting purposes.
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 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.beans.factory.config.BeanFactoryPostProcessor abstract void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) Modify the application context's internal bean factory after its standard initialization.
From interface org.springframework.core.Ordered abstract int getOrder() Return the order value of this object, with a higher value meaning greater in terms of sorting.