Spring Framework

org.springframework.beans.factory.config
Class PropertyResourceConfigurer

java.lang.Object
  extended by org.springframework.core.io.support.PropertiesLoaderSupport
      extended by org.springframework.beans.factory.config.PropertyResourceConfigurer
All Implemented Interfaces:
BeanFactoryPostProcessor, Ordered, PriorityOrdered
Direct Known Subclasses:
PlaceholderConfigurerSupport, PropertyOverrideConfigurer

public abstract class PropertyResourceConfigurer
extends PropertiesLoaderSupport
implements BeanFactoryPostProcessor, PriorityOrdered

Allows for configuration of individual bean property values from a property resource, i.e. a properties file. Useful for custom config files targeted at system administrators that override bean properties configured in the application context.

Two concrete implementations are provided in the distribution:

Property values can be converted after reading them in, through overriding the convertPropertyValue(java.lang.String) method. For example, encrypted values can be detected and decrypted accordingly before processing them.

Since:
02.10.2003
Author:
Juergen Hoeller
See Also:
PropertyOverrideConfigurer, PropertyPlaceholderConfigurer

Field Summary
 
Fields inherited from class org.springframework.core.io.support.PropertiesLoaderSupport
localOverride, localProperties, logger, XML_FILE_EXTENSION
 
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
 
Constructor Summary
PropertyResourceConfigurer()
           
 
Method Summary
protected  void convertProperties(java.util.Properties props)
          Convert the given merged properties, converting property values if necessary.
protected  java.lang.String convertProperty(java.lang.String propertyName, java.lang.String propertyValue)
          Convert the given property from the properties source to the value which should be applied.
protected  java.lang.String convertPropertyValue(java.lang.String originalValue)
          Convert the given property value from the properties source to the value which should be applied.
 int getOrder()
          Return the order value of this object, with a higher value meaning greater in terms of sorting.
 void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
          Merge, convert and process properties against the given bean factory.
protected abstract  void processProperties(ConfigurableListableBeanFactory beanFactory, java.util.Properties props)
          Apply the given Properties to the given BeanFactory.
 void setOrder(int order)
          Set the order value of this object for sorting purposes.
 
Methods inherited from class org.springframework.core.io.support.PropertiesLoaderSupport
loadProperties, mergeProperties, setFileEncoding, setIgnoreResourceNotFound, setLocalOverride, setLocation, setLocations, setProperties, setPropertiesArray, setPropertiesPersister
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertyResourceConfigurer

public PropertyResourceConfigurer()
Method Detail

setOrder

public void setOrder(int order)
Set the order value of this object for sorting purposes.

See Also:
PriorityOrdered

getOrder

public int getOrder()
Description copied from interface: Ordered
Return the order value of this object, with a higher value meaning greater in terms of sorting.

Normally starting with 0, with Integer.MAX_VALUE indicating the greatest value. Same order values will result in arbitrary positions for the affected objects.

Higher values can be interpreted as lower priority. As a consequence, the object with the lowest value has highest priority (somewhat analogous to Servlet "load-on-startup" values).

Specified by:
getOrder in interface Ordered
Returns:
the order value

postProcessBeanFactory

public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
                            throws BeansException
Merge, convert and process properties against the given bean factory.

Specified by:
postProcessBeanFactory in interface BeanFactoryPostProcessor
Parameters:
beanFactory - the bean factory used by the application context
Throws:
BeanInitializationException - if any properties cannot be loaded
BeansException - in case of errors

convertProperties

protected void convertProperties(java.util.Properties props)
Convert the given merged properties, converting property values if necessary. The result will then be processed.

The default implementation will invoke convertPropertyValue(java.lang.String) for each property value, replacing the original with the converted value.

Parameters:
props - the Properties to convert
See Also:
processProperties(org.springframework.beans.factory.config.ConfigurableListableBeanFactory, java.util.Properties)

convertProperty

protected java.lang.String convertProperty(java.lang.String propertyName,
                                           java.lang.String propertyValue)
Convert the given property from the properties source to the value which should be applied.

The default implementation calls convertPropertyValue(String).

Parameters:
propertyName - the name of the property that the value is defined for
propertyValue - the original value from the properties source
Returns:
the converted value, to be used for processing
See Also:
convertPropertyValue(String)

convertPropertyValue

protected java.lang.String convertPropertyValue(java.lang.String originalValue)
Convert the given property value from the properties source to the value which should be applied.

The default implementation simply returns the original value. Can be overridden in subclasses, for example to detect encrypted values and decrypt them accordingly.

Parameters:
originalValue - the original value from the properties source (properties file or local "properties")
Returns:
the converted value, to be used for processing
See Also:
PropertiesLoaderSupport.setProperties(java.util.Properties), PropertiesLoaderSupport.setLocations(org.springframework.core.io.Resource[]), PropertiesLoaderSupport.setLocation(org.springframework.core.io.Resource), convertProperty(String, String)

processProperties

protected abstract void processProperties(ConfigurableListableBeanFactory beanFactory,
                                          java.util.Properties props)
                                   throws BeansException
Apply the given Properties to the given BeanFactory.

Parameters:
beanFactory - the BeanFactory used by the application context
props - the Properties to apply
Throws:
BeansException - in case of errors

Spring Framework