|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.beans.factory.config.PropertyResourceConfigurer org.springframework.beans.factory.config.PropertyPlaceholderConfigurer
A property resource configurer that resolves placeholders in bean property values of context definitions. It pulls values from a properties file into bean definitions.
The default placeholder syntax follows the Ant / Log4J / JSP EL style:
${...}
Example XML context definition:
<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"> <property name="driverClassName"><value>${driver}</value></property> <property name="url"><value>jdbc:${dbname}</value></property> </bean>Example properties file:
driver=com.mysql.jdbc.Driver dbname=mysql:mydbPropertyPlaceholderConfigurer checks simple property values, lists, maps, props, and bean names in bean references. Furthermore, placeholder values can also cross-reference other placeholders, like:
rootPath=myrootdir subPath=${rootPath}/subdirIn contrast to PropertyOverrideConfigurer, this configurer allows to fill in explicit placeholders in context definitions. Therefore, the original definition cannot specify any default values for such bean properties, and the placeholder properties file is supposed to contain an entry for each defined placeholder.
If a configurer cannot resolve a placeholder, a BeanDefinitionStoreException will be thrown. If you want to check against multiple properties files, specify multiple resources via the "locations" setting. You can also define multiple PropertyPlaceholderConfigurers, each with its own placeholder syntax.
Default property values can be defined via "properties", to make overriding definitions in properties files optional. A configurer will also check against system properties (e.g. "user.dir") if it cannot resolve a placeholder with any of the specified properties. This can be customized via "systemPropertiesMode".
Note that the context definition is aware of being incomplete; this is immediately obvious when looking at the XML definition file.
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.
PropertyResourceConfigurer.setLocations(org.springframework.core.io.Resource[])
,
PropertyResourceConfigurer.setProperties(java.util.Properties)
,
setPlaceholderPrefix(java.lang.String)
,
setPlaceholderSuffix(java.lang.String)
,
setSystemPropertiesModeName(java.lang.String)
,
System.getProperty(String)
,
PropertyResourceConfigurer.convertPropertyValue(java.lang.String)
,
PropertyOverrideConfigurer
Field Summary | |
static String |
DEFAULT_PLACEHOLDER_PREFIX
|
static String |
DEFAULT_PLACEHOLDER_SUFFIX
|
static int |
SYSTEM_PROPERTIES_MODE_FALLBACK
Check system properties if not resolvable in the specified properties. |
static int |
SYSTEM_PROPERTIES_MODE_NEVER
Never check system properties. |
static int |
SYSTEM_PROPERTIES_MODE_OVERRIDE
Check system properties first, before trying the specified properties. |
Fields inherited from class org.springframework.beans.factory.config.PropertyResourceConfigurer |
logger |
Constructor Summary | |
PropertyPlaceholderConfigurer()
|
Method Summary | |
protected void |
parseBeanDefinition(Properties props,
BeanDefinition beanDefinition)
|
protected void |
parseGenericArgumentValues(Properties props,
Set gas)
|
protected void |
parseIndexedArgumentValues(Properties props,
Map ias)
|
protected void |
parseList(Properties props,
List listVal)
Parse the given List, resolving its values if necessary. |
protected void |
parseMap(Properties props,
Map mapVal)
Parse the given Map, resolving its values if necessary. |
protected void |
parsePropertyValues(Properties props,
MutablePropertyValues pvs)
|
protected void |
parseSet(Properties props,
Set setVal)
Parse the given Set, resolving its values if necessary. |
protected String |
parseString(Properties props,
String strVal)
Parse the given String, resolving its values if necessary. |
protected String |
parseString(Properties props,
String strVal,
String originalPlaceholder)
Parse values recursively to be able to resolve cross-references between placeholder values. |
protected Object |
parseValue(Properties props,
Object value)
|
protected void |
processProperties(ConfigurableListableBeanFactory beanFactoryToProcess,
Properties props)
Apply the given Properties to the bean factory. |
protected String |
resolvePlaceholder(String placeholder,
Properties props)
Resolve the given placeholder using the given properties. |
protected String |
resolvePlaceholder(String placeholder,
Properties props,
int systemPropertiesMode)
Resolve the given placeholder using the given properties, performing a system properties check according to the given mode. |
void |
setBeanFactory(BeanFactory beanFactory)
Only necessary to check that we're not parsing our own bean definition, to avoid failing on unresolvable placeholders in properties file locations. |
void |
setBeanName(String beanName)
Only necessary to check that we're not parsing our own bean definition, to avoid failing on unresolvable placeholders in properties file locations. |
void |
setIgnoreUnresolvablePlaceholders(boolean ignoreUnresolvablePlaceholders)
Set whether to ignore unresolvable placeholders. |
void |
setPlaceholderPrefix(String placeholderPrefix)
Set the prefix that a placeholder string starts with. |
void |
setPlaceholderSuffix(String placeholderSuffix)
Set the suffix that a placeholder string ends with. |
void |
setSystemPropertiesMode(int systemPropertiesMode)
Set how to check system properties: as fallback, as override, or never. |
void |
setSystemPropertiesModeName(String constantName)
Set the system property mode by the name of the corresponding constant, e.g. |
Methods inherited from class org.springframework.beans.factory.config.PropertyResourceConfigurer |
convertProperties, convertPropertyValue, getOrder, postProcessBeanFactory, setFileEncoding, setIgnoreResourceNotFound, setLocation, setLocations, setOrder, setProperties, setPropertiesPersister |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String DEFAULT_PLACEHOLDER_PREFIX
public static final String DEFAULT_PLACEHOLDER_SUFFIX
public static final int SYSTEM_PROPERTIES_MODE_NEVER
public static final int SYSTEM_PROPERTIES_MODE_FALLBACK
public static final int SYSTEM_PROPERTIES_MODE_OVERRIDE
Constructor Detail |
public PropertyPlaceholderConfigurer()
Method Detail |
public void setPlaceholderPrefix(String placeholderPrefix)
DEFAULT_PLACEHOLDER_PREFIX
public void setPlaceholderSuffix(String placeholderSuffix)
DEFAULT_PLACEHOLDER_SUFFIX
public void setSystemPropertiesModeName(String constantName) throws IllegalArgumentException
constantName
- name of the constant
IllegalArgumentException
- if an invalid constant was specifiedsetSystemPropertiesMode(int)
public void setSystemPropertiesMode(int systemPropertiesMode)
The default is "fallback": If not being able to resolve a placeholder with the specified properties, a system property will be tried. "override" will check for a system property first, before trying the specified properties. "never" will not check system properties at all.
SYSTEM_PROPERTIES_MODE_NEVER
,
SYSTEM_PROPERTIES_MODE_FALLBACK
,
SYSTEM_PROPERTIES_MODE_OVERRIDE
,
setSystemPropertiesModeName(java.lang.String)
public void setIgnoreUnresolvablePlaceholders(boolean ignoreUnresolvablePlaceholders)
public void setBeanName(String beanName)
setBeanName
in interface BeanNameAware
beanName
- the name of the bean in the factoryPropertyResourceConfigurer.setLocations(org.springframework.core.io.Resource[])
,
ResourceEditor
public void setBeanFactory(BeanFactory beanFactory)
setBeanFactory
in interface BeanFactoryAware
beanFactory
- owning BeanFactory (may not be null).
The bean can immediately call methods on the factory.PropertyResourceConfigurer.setLocations(org.springframework.core.io.Resource[])
,
ResourceEditor
protected void processProperties(ConfigurableListableBeanFactory beanFactoryToProcess, Properties props) throws BeansException
PropertyResourceConfigurer
processProperties
in class PropertyResourceConfigurer
beanFactoryToProcess
- the bean factory used by the application contextprops
- the Properties to apply
BeansException
- in case of errorsprotected void parseBeanDefinition(Properties props, BeanDefinition beanDefinition)
protected void parsePropertyValues(Properties props, MutablePropertyValues pvs)
protected void parseIndexedArgumentValues(Properties props, Map ias)
protected void parseGenericArgumentValues(Properties props, Set gas)
protected Object parseValue(Properties props, Object value)
protected void parseList(Properties props, List listVal)
protected void parseSet(Properties props, Set setVal)
protected void parseMap(Properties props, Map mapVal)
protected String parseString(Properties props, String strVal) throws BeansException
BeansException
parseString(java.util.Properties, String, String)
protected String parseString(Properties props, String strVal, String originalPlaceholder) throws BeansException
BeansException
protected String resolvePlaceholder(String placeholder, Properties props, int systemPropertiesMode)
Default implementation delegates to resolvePlaceholder
(placeholder, props)
before/after the system properties check.
Subclasses can override this for custom resolution strategies, including customized points for the system properties check.
placeholder
- the placeholder to resolveprops
- the merged properties of this configurersystemPropertiesMode
- the system properties mode,
according to the constants in this class
setSystemPropertiesMode(int)
,
System.getProperty(java.lang.String)
,
resolvePlaceholder(String, java.util.Properties)
protected String resolvePlaceholder(String placeholder, Properties props)
Subclasses can override this for customized placeholder-to-key mappings or custom resolution strategies, possibly just using the given properties as fallback.
Note that system properties will still be checked before respectively after this method is invoked, according to the system properties mode.
placeholder
- the placeholder to resolveprops
- the merged properties of this configurer
setSystemPropertiesMode(int)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |