org.springframework.beans.factory.config

Class PropertyOverrideConfigurer

  • All Implemented Interfaces:
    BeanFactoryPostProcessor, Ordered, PriorityOrdered


    public class PropertyOverrideConfigurer
    extends 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.

    Since:
    12.03.2003
    Author:
    Juergen Hoeller, Rod Johnson
    See Also:
    PropertyResourceConfigurer.convertPropertyValue(java.lang.String), PropertyPlaceholderConfigurer
    • Field Detail

      • DEFAULT_BEAN_NAME_SEPARATOR

        public static final java.lang.String DEFAULT_BEAN_NAME_SEPARATOR
        The default bean name separator.
        See Also:
        Constant Field Values
    • Constructor Detail

      • PropertyOverrideConfigurer

        public PropertyOverrideConfigurer()
    • Method Detail

      • setBeanNameSeparator

        public void setBeanNameSeparator(java.lang.String beanNameSeparator)
        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.

      • applyPropertyValue

        protected void applyPropertyValue(ConfigurableListableBeanFactory factory,
                                          java.lang.String beanName,
                                          java.lang.String property,
                                          java.lang.String value)
        Apply the given property value to the corresponding bean.
      • hasPropertyOverridesFor

        public boolean hasPropertyOverridesFor(java.lang.String beanName)
        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