Spring Beans 6.1.4 · org.springframework.beans.factory.config.PropertyResourceConfigurer

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:

PropertyOverrideConfigurer for "beanName.property=value" style overriding (pushing values from a properties file into bean definitions)
PropertyPlaceholderConfigurer for replacing "${...}" placeholders (pulling values from a properties file into bean definitions)

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

Modifier and Type	Field and Description
private int	order

Inherited from org.springframework.core.io.support.PropertiesLoaderSupport:: localOverride localProperties logger

Constructor Summary

Access	Constructor and Description
public	PropertyResourceConfigurer()

Method Summary

Modifier and Type	Method and Description
protected void	convertProperties(Properties the Properties to convert props) Convert the given merged properties, converting property values if necessary.
protected String	Returns: the converted value, to be used for processing convertProperty(String the name of the property that the value is defined for propertyName, String the original value from the properties source propertyValue) Convert the given property from the properties source to the value which should be applied.
protected String	Returns: the converted value, to be used for processing convertPropertyValue(String the original value from the properties source (properties file or local "properties") originalValue) Convert the given property value from the properties source to the value which should be applied.
public int	getOrder() Implements org.springframework.core.Ordered.getOrder. Get the order value of this object.
public void	postProcessBeanFactory(ConfigurableListableBeanFactory the bean factory used by the application context beanFactory) Implements org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory. Merge, convert and process properties against the given bean factory.
protected abstract void	processProperties(ConfigurableListableBeanFactory the BeanFactory used by the application context beanFactory, Properties the Properties to apply props) Apply the given Properties to the given BeanFactory.
public void	setOrder(int order) Set the order value of this object for sorting purposes.

Inherited from org.springframework.core.io.support.PropertiesLoaderSupport:: loadProperties mergeProperties setFileEncoding setIgnoreResourceNotFound setLocalOverride setLocation setLocations setProperties setPropertiesArray setPropertiesPersister

Field Detail

order	back to summary
private int order

Constructor Detail

PropertyResourceConfigurer	back to summary
public PropertyResourceConfigurer()

Method Detail

convertProperties back to summary

convertProperties	back to summary
protected void convertProperties(Properties props) Convert the given merged properties, converting property values if necessary. The result will then be processed. The default implementation will invoke `convertPropertyValue` for each property value, replacing the original with the converted value. Parameters props:Properties the Properties to convert See Also `processProperties`

protected void convertProperties(Properties props)

Convert the given merged properties, converting property values if necessary. The result will then be processed.

The default implementation will invoke convertPropertyValue for each property value, replacing the original with the converted value.

Parameters

props:Properties: the Properties to convert

See Also

processProperties

convertProperty back to summary

convertProperty	back to summary
protected String convertProperty(String propertyName, 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:String the name of the property that the value is defined for propertyValue:String the original value from the properties source Returns:String the converted value, to be used for processing See Also `convertPropertyValue(String)`

protected String convertProperty(String propertyName, 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:String: the name of the property that the value is defined for
propertyValue:String: the original value from the properties source

Returns:String

the converted value, to be used for processing

See Also

convertPropertyValue(String)

convertPropertyValue back to summary

convertPropertyValue	back to summary
protected String convertPropertyValue(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:String the original value from the properties source (properties file or local "properties") Returns:String the converted value, to be used for processing See Also `setProperties`, `setLocations`, `setLocation`, `convertProperty(String, String)`

protected String convertPropertyValue(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:String: the original value from the properties source (properties file or local "properties")

Returns:String

the converted value, to be used for processing

getOrder back to summary

getOrder	back to summary
public int getOrder() Implements org.springframework.core.Ordered.getOrder. Doc from org.springframework.core.Ordered.getOrder. Get the order value of this object. Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet `load-on-startup` values). Same order values will result in arbitrary sort positions for the affected objects. Returns:int the order value Annotations @Override

public int getOrder()

Implements org.springframework.core.Ordered.getOrder.

Doc from org.springframework.core.Ordered.getOrder.

Get the order value of this object.

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

Same order values will result in arbitrary sort positions for the affected objects.

Returns:int

the order value

Annotations

@Override

postProcessBeanFactory	back to summary
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException Implements org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory. Merge, convert and process properties against the given bean factory. Parameters beanFactory:ConfigurableListableBeanFactory Doc from org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory. the bean factory used by the application context Annotations @Override Exceptions BeansException: Doc from org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory. in case of errors BeanInitializationException: if any properties cannot be loaded

postProcessBeanFactory

back to summary

public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException

Implements org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory.

Merge, convert and process properties against the given bean factory.

Parameters

beanFactory:ConfigurableListableBeanFactory

Doc from org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory.

the bean factory used by the application context

Annotations

@Override

Exceptions

BeansException:

Doc from org.springframework.beans.factory.config.BeanFactoryPostProcessor.postProcessBeanFactory.

in case of errors

BeanInitializationException:

if any properties cannot be loaded

processProperties	back to summary
protected abstract void processProperties(ConfigurableListableBeanFactory beanFactory, Properties props) throws BeansException Apply the given Properties to the given BeanFactory. Parameters beanFactory:ConfigurableListableBeanFactory the BeanFactory used by the application context props:Properties the Properties to apply Exceptions BeansException: in case of errors

processProperties

back to summary

protected abstract void processProperties(ConfigurableListableBeanFactory beanFactory, Properties props) throws BeansException

Apply the given Properties to the given BeanFactory.

Parameters

beanFactory:ConfigurableListableBeanFactory: the BeanFactory used by the application context
props:Properties: the Properties to apply

Exceptions

BeansException:: in case of errors

setOrder back to summary

setOrder	back to summary
public void setOrder(int order) Set the order value of this object for sorting purposes. See Also `PriorityOrdered`

public void setOrder(int order)

Set the order value of this object for sorting purposes.

See Also: PriorityOrdered

public abstract Class PropertyResourceConfigurer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail