spring-framework / org.springframework.beans.factory.config / PropertyOverrideConfigurer

PropertyOverrideConfigurer

open class PropertyOverrideConfigurer : PropertyResourceConfigurer

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.

Author
Juergen Hoeller

Author
Rod Johnson

Since
12.03.2003

See Also
#convertPropertyValuePropertyPlaceholderConfigurer

Constructors

<init>

 PropertyOverrideConfigurer()

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.

Properties

DEFAULT_BEAN_NAME_SEPARATOR

 static val DEFAULT_BEAN_NAME_SEPARATOR: String

Functions

hasPropertyOverridesFor

 open fun hasPropertyOverridesFor(beanName: String): Boolean

Were there overrides for this bean? Only valid after processing has occurred at least once.

setBeanNameSeparator

 open fun setBeanNameSeparator(beanNameSeparator: String): Unit

Set the separator to expect between bean name and property path. Default is a dot (".").

setIgnoreInvalidKeys

 open fun setIgnoreInvalidKeys(ignoreInvalidKeys: Boolean): Unit

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.