Top Description Fields Constructors Methods
org.springframework.beans.factory.config

public Class PropertyOverrideConfigurer

extends PropertyResourceConfigurer
Class Inheritance
Imports
java.util.Collections, .Enumeration, .Properties, .Set, java.util.concurrent.ConcurrentHashMap, org.springframework.beans.BeansException, .PropertyValue, org.springframework.beans.factory.BeanInitializationException

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.

Authors
Juergen Hoeller, Rod Johnson
Since
12.03.2003
See Also
convertPropertyValue, PropertyPlaceholderConfigurer

Field Summary

Modifier and TypeField and Description
private final Set<String>
beanNames

Contains names of beans that have overrides.

private String
public static final String
DEFAULT_BEAN_NAME_SEPARATOR

The default bean name separator.

private boolean

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
protected void
applyPropertyValue(ConfigurableListableBeanFactory factory, String beanName, String property, String value)

Apply the given property value to the corresponding bean.

public boolean

Returns:

whether there were property overrides for the named bean
hasPropertyOverridesFor
(String
name of the bean to query status for
beanName
)

Were there overrides for this bean?

protected void
processKey(ConfigurableListableBeanFactory factory, String key, String value)

Process the given key as 'beanName.property' entry.

protected void
processProperties(ConfigurableListableBeanFactory
the BeanFactory used by the application context
beanFactory
,
Properties
the Properties to apply
props
)

Implements abstract org.springframework.beans.factory.config.PropertyResourceConfigurer.processProperties.

Apply the given Properties to the given BeanFactory.

public void
setBeanNameSeparator(String beanNameSeparator)

Set the separator to expect between bean name and property path.

public void
setIgnoreInvalidKeys(boolean ignoreInvalidKeys)

Set whether to ignore invalid keys.

Inherited from org.springframework.beans.factory.config.PropertyResourceConfigurer:
convertPropertiesconvertPropertyconvertPropertyValuegetOrderpostProcessBeanFactorysetOrder

Field Detail

beanNamesback to summary
private final Set<String> beanNames

Contains names of beans that have overrides.

beanNameSeparatorback to summary
private String beanNameSeparator
DEFAULT_BEAN_NAME_SEPARATORback to summary
public static final String DEFAULT_BEAN_NAME_SEPARATOR

The default bean name separator.

ignoreInvalidKeysback to summary
private boolean ignoreInvalidKeys

Constructor Detail

PropertyOverrideConfigurerback to summary
public PropertyOverrideConfigurer()

Method Detail

applyPropertyValueback to summary
protected void applyPropertyValue(ConfigurableListableBeanFactory factory, String beanName, String property, String value)

Apply the given property value to the corresponding bean.

hasPropertyOverridesForback to summary
public boolean hasPropertyOverridesFor(String beanName)

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

Parameters
beanName:String

name of the bean to query status for

Returns:boolean

whether there were property overrides for the named bean

processKeyback to summary
protected void processKey(ConfigurableListableBeanFactory factory, String key, String value) throws BeansException

Process the given key as 'beanName.property' entry.

processPropertiesback to summary
protected void processProperties(ConfigurableListableBeanFactory beanFactory, Properties props) throws BeansException

Implements abstract org.springframework.beans.factory.config.PropertyResourceConfigurer.processProperties.

Doc from org.springframework.beans.factory.config.PropertyResourceConfigurer.processProperties.

Apply the given Properties to the given BeanFactory.

Parameters
beanFactory:ConfigurableListableBeanFactory

the BeanFactory used by the application context

props:Properties

the Properties to apply

Annotations
@Override
Exceptions
BeansException:
in case of errors
setBeanNameSeparatorback to summary
public void setBeanNameSeparator(String beanNameSeparator)

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

setIgnoreInvalidKeysback to summary
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.