org.springframework.boot.context.properties

Class ConfigurationPropertiesBindingPostProcessor

java.lang.Object

org.springframework.boot.context.properties.ConfigurationPropertiesBindingPostProcessor

All Implemented Interfaces:

EventListener, Aware, BeanFactoryAware, BeanPostProcessor, DisposableBean, InitializingBean, ApplicationContextAware, ApplicationListener<ContextRefreshedEvent>, EnvironmentAware, Ordered, PriorityOrdered

public class ConfigurationPropertiesBindingPostProcessor
extends Object
implements BeanPostProcessor, BeanFactoryAware, EnvironmentAware, ApplicationContextAware, InitializingBean, DisposableBean, ApplicationListener<ContextRefreshedEvent>, PriorityOrdered

BeanPostProcessor to bind PropertySources to beans annotated with ConfigurationProperties.

Since:

1.0.0

Author:

Dave Syer, Phillip Webb, Christian Dupuis, Stephane Nicoll

Field Summary

Fields

Modifier and Type	Field and Description
static String	VALIDATOR_BEAN_NAME The bean name of the configuration properties validator.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ConfigurationPropertiesBindingPostProcessor()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
int	getOrder() Return the order of the bean.
void	onApplicationEvent(ContextRefreshedEvent event)
Object	postProcessAfterInitialization(Object bean, String beanName)
Object	postProcessBeforeInitialization(Object bean, String beanName)
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanFactory(BeanFactory beanFactory)
void	setBeanMetaDataStore(ConfigurationBeanFactoryMetaData beans) Set the bean meta-data store.
void	setConversionService(ConversionService conversionService) Set the conversion service used to convert property values.
void	setConverters(List<Converter<?,?>> converters) A list of custom converters (in addition to the defaults) to use when converting properties for binding.
void	setEnvironment(Environment environment)
void	setGenericConverters(List<GenericConverter> converters) A list of custom converters (in addition to the defaults) to use when converting properties for binding.
void	setOrder(int order) Set the order of the bean.
void	setPropertySources(PropertySources propertySources) Set the property sources to bind.
void	setValidator(Validator validator) Set the bean validator used to validate property fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALIDATOR_BEAN_NAME

public static final String VALIDATOR_BEAN_NAME

The bean name of the configuration properties validator.

See Also:

Constant Field Values

Constructor Detail

ConfigurationPropertiesBindingPostProcessor

public ConfigurationPropertiesBindingPostProcessor()

Method Detail

setConverters

@Autowired(required=false)
 @ConfigurationPropertiesBinding
public void setConverters(List<Converter<?,?>> converters)

A list of custom converters (in addition to the defaults) to use when converting properties for binding.

Parameters:

converters - the converters to set

setGenericConverters

@Autowired(required=false)
 @ConfigurationPropertiesBinding
public void setGenericConverters(List<GenericConverter> converters)

A list of custom converters (in addition to the defaults) to use when converting properties for binding.

Parameters:

converters - the converters to set

setOrder

public void setOrder(int order)

Set the order of the bean.

Parameters:

order - the order

getOrder

public int getOrder()

Return the order of the bean.

Specified by:

getOrder in interface Ordered

Returns:

the order

setPropertySources

public void setPropertySources(PropertySources propertySources)

Set the property sources to bind.

Parameters:

propertySources - the property sources

setValidator

public void setValidator(Validator validator)

Set the bean validator used to validate property fields.

Parameters:

validator - the validator

setConversionService

public void setConversionService(ConversionService conversionService)

Set the conversion service used to convert property values.

Parameters:

conversionService - the conversion service

setBeanMetaDataStore

public void setBeanMetaDataStore(ConfigurationBeanFactoryMetaData beans)

Set the bean meta-data store.

Parameters:

beans - the bean meta data store

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

setEnvironment

public void setEnvironment(Environment environment)

Specified by:

setEnvironment in interface EnvironmentAware

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface ApplicationContextAware

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

onApplicationEvent

public void onApplicationEvent(ContextRefreshedEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ContextRefreshedEvent>

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface DisposableBean

Throws:

Exception

postProcessBeforeInitialization

public Object postProcessBeforeInitialization(Object bean,
                                              String beanName)
                                       throws BeansException

Specified by:

postProcessBeforeInitialization in interface BeanPostProcessor

Throws:

BeansException

postProcessAfterInitialization

public Object postProcessAfterInitialization(Object bean,
                                             String beanName)
                                      throws BeansException

Specified by:

postProcessAfterInitialization in interface BeanPostProcessor

Throws:

BeansException