Class ConfigurationPropertiesRebinder

java.lang.Object

org.springframework.cloud.context.properties.ConfigurationPropertiesRebinder

All Implemented Interfaces:

EventListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<EnvironmentChangeEvent>

@Component
@ManagedResource
public class ConfigurationPropertiesRebinder
extends Object
implements org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<EnvironmentChangeEvent>

Listens for EnvironmentChangeEvent and rebinds beans that were bound to the Environment using @ConfigurationProperties. When these beans are re-bound and re-initialized, the changes are available immediately to any component that is using the @ConfigurationProperties bean.

Author:

Dave Syer, Yanming Zhou

See Also:

• for a deeper and optionally more focused refresh of bean components.

Constructor Summary

Constructors

Constructor	Description
ConfigurationPropertiesRebinder(ConfigurationPropertiesBeans beans)

Method Summary

Modifier and Type	Method	Description
Set<String>	getBeanNames()
Map<String, Exception>	getErrors()	A map of bean name to errors when instantiating the bean.
Set<String>	getNeverRefreshable()
void	onApplicationEvent(EnvironmentChangeEvent event)
void	rebind()
boolean	rebind(Class type)	WARNING: This method rebinds beans from any context in the hierarchy using the main application context.
boolean	rebind(String name)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.ApplicationListener

supportsAsyncExecution

Constructor Details

ConfigurationPropertiesRebinder

public ConfigurationPropertiesRebinder(ConfigurationPropertiesBeans beans)

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getErrors

public Map<String, Exception> getErrors()

A map of bean name to errors when instantiating the bean.

Returns:

The errors accumulated since the latest destroy.

rebind

@ManagedOperation
public void rebind()

rebind

@ManagedOperation
public boolean rebind(String name)

rebind

public boolean rebind(Class type)

WARNING: This method rebinds beans from any context in the hierarchy using the main application context.

Parameters:

type - bean type to rebind.

Returns:

true, if successful.

getNeverRefreshable

@ManagedAttribute
public Set<String> getNeverRefreshable()

getBeanNames

@ManagedAttribute
public Set<String> getBeanNames()

onApplicationEvent

public void onApplicationEvent(EnvironmentChangeEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<EnvironmentChangeEvent>