Save This Page
Home » spring-framework-2.5.5-with-dependencies » org.springframework » beans » factory » config » [javadoc | source]
org.springframework.beans.factory.config
public class: PropertyOverrideConfigurer [javadoc | source]
java.lang.Object
   org.springframework.core.io.support.PropertiesLoaderSupport
      org.springframework.beans.factory.config.PropertyResourceConfigurer
         org.springframework.beans.factory.config.PropertyOverrideConfigurer

All Implemented Interfaces:
    PriorityOrdered, BeanFactoryPostProcessor

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.

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.

Field Summary
public static final  String DEFAULT_BEAN_NAME_SEPARATOR     
Fields inherited from org.springframework.core.io.support.PropertiesLoaderSupport:
XML_FILE_EXTENSION,  logger
Method from org.springframework.beans.factory.config.PropertyOverrideConfigurer Summary:
applyPropertyValue,   hasPropertyOverridesFor,   processKey,   processProperties,   setBeanNameSeparator,   setIgnoreInvalidKeys
Methods from org.springframework.beans.factory.config.PropertyResourceConfigurer:
convertProperties,   convertPropertyValue,   getOrder,   postProcessBeanFactory,   processProperties,   setOrder
Methods from org.springframework.core.io.support.PropertiesLoaderSupport:
loadProperties,   mergeProperties,   setFileEncoding,   setIgnoreResourceNotFound,   setLocalOverride,   setLocation,   setLocations,   setProperties,   setPropertiesArray,   setPropertiesPersister
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.beans.factory.config.PropertyOverrideConfigurer Detail:
 protected  void applyPropertyValue(ConfigurableListableBeanFactory factory,
    String beanName,
    String property,
    String value) 
    Apply the given property value to the corresponding bean.
 public 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) throws BeansException 
    Process the given key as 'beanName.property' entry.
 protected  void processProperties(ConfigurableListableBeanFactory beanFactory,
    Properties props) throws BeansException 
 public  void setBeanNameSeparator(String beanNameSeparator) 
    Set the separator to expect between bean name and property path. Default is a dot (".").
 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 will just be logged as warning. This allows to have arbitrary other keys in a properties file.