Class PropertyOverrideConfigurer
- All Implemented Interfaces:
BeanFactoryPostProcessor
,Ordered
,PriorityOrdered
Configuration lines are expected to be of the following form:
beanName.property=valueExample properties file:
dataSource.driverClassName=com.mysql.jdbc.Driver dataSource.url=jdbc:mysql:mydbIn 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.
- Since:
- 12.03.2003
- Author:
- Juergen Hoeller, Rod Johnson
- See Also:
-
Field Summary
Fields inherited from class org.springframework.core.io.support.PropertiesLoaderSupport
localOverride, localProperties, logger
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
applyPropertyValue
(ConfigurableListableBeanFactory factory, String beanName, String property, String value) Apply the given property value to the corresponding bean.boolean
hasPropertyOverridesFor
(String beanName) Were there overrides for this bean? Only valid after processing has occurred at least once.protected void
processKey
(ConfigurableListableBeanFactory factory, String key, String value) Process the given key as 'beanName.property' entry.protected void
processProperties
(ConfigurableListableBeanFactory beanFactory, Properties props) Apply the given Properties to the given BeanFactory.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.Methods inherited from class org.springframework.beans.factory.config.PropertyResourceConfigurer
convertProperties, convertProperty, convertPropertyValue, getOrder, postProcessBeanFactory, setOrder
Methods inherited from class org.springframework.core.io.support.PropertiesLoaderSupport
loadProperties, mergeProperties, setFileEncoding, setIgnoreResourceNotFound, setLocalOverride, setLocation, setLocations, setProperties, setPropertiesArray, setPropertiesPersister
-
Field Details
-
DEFAULT_BEAN_NAME_SEPARATOR
The default bean name separator.- See Also:
-
-
Constructor Details
-
PropertyOverrideConfigurer
public PropertyOverrideConfigurer()
-
-
Method Details
-
setBeanNameSeparator
Set the separator to expect between bean name and property path. Default is a dot ("."). -
setIgnoreInvalidKeys
public void setIgnoreInvalidKeys(boolean ignoreInvalidKeys) Set whether to ignore invalid keys. Default is "false".If you ignore invalid keys, keys that do not follow the 'beanName.property' format (or refer to invalid bean names or properties) will just be logged at debug level. This allows one to have arbitrary other keys in a properties file.
-
processProperties
protected void processProperties(ConfigurableListableBeanFactory beanFactory, Properties props) throws BeansException Description copied from class:PropertyResourceConfigurer
Apply the given Properties to the given BeanFactory.- Specified by:
processProperties
in classPropertyResourceConfigurer
- Parameters:
beanFactory
- the BeanFactory used by the application contextprops
- the Properties to apply- Throws:
BeansException
- in case of errors
-
processKey
protected void processKey(ConfigurableListableBeanFactory factory, String key, String value) throws BeansException Process the given key as 'beanName.property' entry.- Throws:
BeansException
-
applyPropertyValue
protected void applyPropertyValue(ConfigurableListableBeanFactory factory, String beanName, String property, String value) Apply the given property value to the corresponding bean. -
hasPropertyOverridesFor
Were there overrides for this bean? Only valid after processing has occurred at least once.- Parameters:
beanName
- name of the bean to query status for- Returns:
- whether there were property overrides for the named bean
-