Interface ConfigurableBeanFactory
- All Superinterfaces:
BeanFactory
,HierarchicalBeanFactory
,SingletonBeanRegistry
- All Known Subinterfaces:
ConfigurableListableBeanFactory
- All Known Implementing Classes:
AbstractAutowireCapableBeanFactory
,AbstractBeanFactory
,DefaultListableBeanFactory
BeanFactory
interface.
This bean factory interface is not meant to be used in normal application
code: Stick to BeanFactory
or
ListableBeanFactory
for typical
needs. This extended interface is just meant to allow for framework-internal
plug'n'play and for special access to bean factory configuration methods.
- Since:
- 03.11.2003
- Author:
- Juergen Hoeller
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Scope identifier for the standard prototype scope: "prototype".static final String
Scope identifier for the standard singleton scope: "singleton".Fields inherited from interface org.springframework.beans.factory.BeanFactory
FACTORY_BEAN_PREFIX
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addBeanPostProcessor
(BeanPostProcessor beanPostProcessor) Add a new BeanPostProcessor that will get applied to beans created by this factory.void
addEmbeddedValueResolver
(StringValueResolver valueResolver) Add a String resolver for embedded values such as annotation attributes.void
Add a PropertyEditorRegistrar to be applied to all bean creation processes.void
copyConfigurationFrom
(ConfigurableBeanFactory otherFactory) Copy all relevant configuration from the given other factory.void
Initialize the given PropertyEditorRegistry with the custom editors that have been registered with this BeanFactory.void
destroyBean
(String beanName, Object beanInstance) Destroy the given bean instance (usually a prototype instance obtained from this factory) according to its bean definition.void
destroyScopedBean
(String beanName) Destroy the specified scoped bean in the current target scope, if any.void
Destroy all singleton beans in this factory, including inner beans that have been registered as disposable.Return theApplicationStartup
for this bean factory.Return this factory's class loader for loading bean classes (onlynull
if even the system ClassLoader isn't accessible).Return the resolution strategy for expressions in bean definition values.int
Return the current number of registered BeanPostProcessors, if any.Return the associated ConversionService, if any.String[]
getDependenciesForBean
(String beanName) Return the names of all beans that the specified bean depends on, if any.String[]
getDependentBeans
(String beanName) Return the names of all beans which depend on the specified bean, if any.getMergedBeanDefinition
(String beanName) Return a merged BeanDefinition for the given bean name, merging a child bean definition with its parent if necessary.getRegisteredScope
(String scopeName) Return the Scope implementation for the given scope name, if any.String[]
Return the names of all currently registered scopes.Return the temporary ClassLoader to use for type matching purposes, if any.Obtain a type converter as used by this BeanFactory.boolean
Determine whether an embedded value resolver has been registered with this bean factory, to be applied throughresolveEmbeddedValue(String)
.boolean
Return whether to cache bean metadata such as given bean definitions (in merged fashion) and resolved bean classes.boolean
isCurrentlyInCreation
(String beanName) Determine whether the specified bean is currently in creation.boolean
isFactoryBean
(String name) Determine whether the bean with the given name is a FactoryBean.void
registerAlias
(String beanName, String alias) Given a bean name, create an alias.void
registerCustomEditor
(Class<?> requiredType, Class<? extends PropertyEditor> propertyEditorClass) Register the given custom property editor for all properties of the given type.void
registerDependentBean
(String beanName, String dependentBeanName) Register a dependent bean for the given bean, to be destroyed before the given bean is destroyed.void
registerScope
(String scopeName, Scope scope) Register the given scope, backed by the given Scope implementation.void
resolveAliases
(StringValueResolver valueResolver) Resolve all alias target names and aliases registered in this factory, applying the given StringValueResolver to them.resolveEmbeddedValue
(String value) Resolve the given embedded value, e.g.void
setApplicationStartup
(ApplicationStartup applicationStartup) Set theApplicationStartup
for this bean factory.void
setBeanClassLoader
(ClassLoader beanClassLoader) Set the class loader to use for loading bean classes.void
Specify the resolution strategy for expressions in bean definition values.void
setCacheBeanMetadata
(boolean cacheBeanMetadata) Set whether to cache bean metadata such as given bean definitions (in merged fashion) and resolved bean classes.void
setConversionService
(ConversionService conversionService) Specify a Spring 3.0 ConversionService to use for converting property values, as an alternative to JavaBeans PropertyEditors.void
setCurrentlyInCreation
(String beanName, boolean inCreation) Explicitly control the current in-creation status of the specified bean.void
setParentBeanFactory
(BeanFactory parentBeanFactory) Set the parent of this bean factory.void
setTempClassLoader
(ClassLoader tempClassLoader) Specify a temporary ClassLoader to use for type matching purposes.void
setTypeConverter
(TypeConverter typeConverter) Set a custom type converter that this BeanFactory should use for converting bean property values, constructor argument values, etc.Methods inherited from interface org.springframework.beans.factory.BeanFactory
containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getType, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch
Methods inherited from interface org.springframework.beans.factory.HierarchicalBeanFactory
containsLocalBean, getParentBeanFactory
Methods inherited from interface org.springframework.beans.factory.config.SingletonBeanRegistry
containsSingleton, getSingleton, getSingletonCount, getSingletonMutex, getSingletonNames, registerSingleton
-
Field Details
-
SCOPE_SINGLETON
Scope identifier for the standard singleton scope: "singleton".Custom scopes can be added via
registerScope
. -
SCOPE_PROTOTYPE
Scope identifier for the standard prototype scope: "prototype".Custom scopes can be added via
registerScope
.
-
-
Method Details
-
setParentBeanFactory
Set the parent of this bean factory.Note that the parent cannot be changed: It should only be set outside a constructor if it isn't available at the time of factory instantiation.
- Parameters:
parentBeanFactory
- the parent BeanFactory- Throws:
IllegalStateException
- if this factory is already associated with a parent BeanFactory- See Also:
-
setBeanClassLoader
Set the class loader to use for loading bean classes. Default is the thread context class loader.Note that this class loader will only apply to bean definitions that do not carry a resolved bean class yet. This is the case as of Spring 2.0 by default: Bean definitions only carry bean class names, to be resolved once the factory processes the bean definition.
- Parameters:
beanClassLoader
- the class loader to use, ornull
to suggest the default class loader
-
getBeanClassLoader
Return this factory's class loader for loading bean classes (onlynull
if even the system ClassLoader isn't accessible).- See Also:
-
setTempClassLoader
Specify a temporary ClassLoader to use for type matching purposes. Default is none, simply using the standard bean ClassLoader.A temporary ClassLoader is usually just specified if load-time weaving is involved, to make sure that actual bean classes are loaded as lazily as possible. The temporary loader is then removed once the BeanFactory completes its bootstrap phase.
- Since:
- 2.5
-
getTempClassLoader
Return the temporary ClassLoader to use for type matching purposes, if any.- Since:
- 2.5
-
setCacheBeanMetadata
void setCacheBeanMetadata(boolean cacheBeanMetadata) Set whether to cache bean metadata such as given bean definitions (in merged fashion) and resolved bean classes. Default is on.Turn this flag off to enable hot-refreshing of bean definition objects and in particular bean classes. If this flag is off, any creation of a bean instance will re-query the bean class loader for newly resolved classes.
-
isCacheBeanMetadata
boolean isCacheBeanMetadata()Return whether to cache bean metadata such as given bean definitions (in merged fashion) and resolved bean classes. -
setBeanExpressionResolver
Specify the resolution strategy for expressions in bean definition values.There is no expression support active in a BeanFactory by default. An ApplicationContext will typically set a standard expression strategy here, supporting "#{...}" expressions in a Unified EL compatible style.
- Since:
- 3.0
-
getBeanExpressionResolver
Return the resolution strategy for expressions in bean definition values.- Since:
- 3.0
-
setConversionService
Specify a Spring 3.0 ConversionService to use for converting property values, as an alternative to JavaBeans PropertyEditors.- Since:
- 3.0
-
getConversionService
Return the associated ConversionService, if any.- Since:
- 3.0
-
addPropertyEditorRegistrar
Add a PropertyEditorRegistrar to be applied to all bean creation processes.Such a registrar creates new PropertyEditor instances and registers them on the given registry, fresh for each bean creation attempt. This avoids the need for synchronization on custom editors; hence, it is generally preferable to use this method instead of
registerCustomEditor(java.lang.Class<?>, java.lang.Class<? extends java.beans.PropertyEditor>)
.- Parameters:
registrar
- the PropertyEditorRegistrar to register
-
registerCustomEditor
void registerCustomEditor(Class<?> requiredType, Class<? extends PropertyEditor> propertyEditorClass) Register the given custom property editor for all properties of the given type. To be invoked during factory configuration.Note that this method will register a shared custom editor instance; access to that instance will be synchronized for thread-safety. It is generally preferable to use
addPropertyEditorRegistrar(org.springframework.beans.PropertyEditorRegistrar)
instead of this method, to avoid for the need for synchronization on custom editors.- Parameters:
requiredType
- type of the propertypropertyEditorClass
- thePropertyEditor
class to register
-
copyRegisteredEditorsTo
Initialize the given PropertyEditorRegistry with the custom editors that have been registered with this BeanFactory.- Parameters:
registry
- the PropertyEditorRegistry to initialize
-
setTypeConverter
Set a custom type converter that this BeanFactory should use for converting bean property values, constructor argument values, etc.This will override the default PropertyEditor mechanism and hence make any custom editors or custom editor registrars irrelevant.
-
getTypeConverter
TypeConverter getTypeConverter()Obtain a type converter as used by this BeanFactory. This may be a fresh instance for each call, since TypeConverters are usually not thread-safe.If the default PropertyEditor mechanism is active, the returned TypeConverter will be aware of all custom editors that have been registered.
- Since:
- 2.5
-
addEmbeddedValueResolver
Add a String resolver for embedded values such as annotation attributes.- Parameters:
valueResolver
- the String resolver to apply to embedded values- Since:
- 3.0
-
hasEmbeddedValueResolver
boolean hasEmbeddedValueResolver()Determine whether an embedded value resolver has been registered with this bean factory, to be applied throughresolveEmbeddedValue(String)
.- Since:
- 4.3
-
resolveEmbeddedValue
Resolve the given embedded value, e.g. an annotation attribute.- Parameters:
value
- the value to resolve- Returns:
- the resolved value (may be the original value as-is)
- Since:
- 3.0
-
addBeanPostProcessor
Add a new BeanPostProcessor that will get applied to beans created by this factory. To be invoked during factory configuration.Note: Post-processors submitted here will be applied in the order of registration; any ordering semantics expressed through implementing the
Ordered
interface will be ignored. Note that autodetected post-processors (e.g. as beans in an ApplicationContext) will always be applied after programmatically registered ones.- Parameters:
beanPostProcessor
- the post-processor to register
-
getBeanPostProcessorCount
int getBeanPostProcessorCount()Return the current number of registered BeanPostProcessors, if any. -
registerScope
Register the given scope, backed by the given Scope implementation.- Parameters:
scopeName
- the scope identifierscope
- the backing Scope implementation
-
getRegisteredScopeNames
String[] getRegisteredScopeNames()Return the names of all currently registered scopes.This will only return the names of explicitly registered scopes. Built-in scopes such as "singleton" and "prototype" won't be exposed.
- Returns:
- the array of scope names, or an empty array if none
- See Also:
-
getRegisteredScope
Return the Scope implementation for the given scope name, if any.This will only return explicitly registered scopes. Built-in scopes such as "singleton" and "prototype" won't be exposed.
- Parameters:
scopeName
- the name of the scope- Returns:
- the registered Scope implementation, or
null
if none - See Also:
-
setApplicationStartup
Set theApplicationStartup
for this bean factory.This allows the application context to record metrics during application startup.
- Parameters:
applicationStartup
- the new application startup- Since:
- 5.3
-
getApplicationStartup
ApplicationStartup getApplicationStartup()Return theApplicationStartup
for this bean factory.- Since:
- 5.3
-
copyConfigurationFrom
Copy all relevant configuration from the given other factory.Should include all standard configuration settings as well as BeanPostProcessors, Scopes, and factory-specific internal settings. Should not include any metadata of actual bean definitions, such as BeanDefinition objects and bean name aliases.
- Parameters:
otherFactory
- the other BeanFactory to copy from
-
registerAlias
Given a bean name, create an alias. We typically use this method to support names that are illegal within XML ids (used for bean names).Typically invoked during factory configuration, but can also be used for runtime registration of aliases. Therefore, a factory implementation should synchronize alias access.
- Parameters:
beanName
- the canonical name of the target beanalias
- the alias to be registered for the bean- Throws:
BeanDefinitionStoreException
- if the alias is already in use
-
resolveAliases
Resolve all alias target names and aliases registered in this factory, applying the given StringValueResolver to them.The value resolver may for example resolve placeholders in target bean names and even in alias names.
- Parameters:
valueResolver
- the StringValueResolver to apply- Since:
- 2.5
-
getMergedBeanDefinition
Return a merged BeanDefinition for the given bean name, merging a child bean definition with its parent if necessary. Considers bean definitions in ancestor factories as well.- Parameters:
beanName
- the name of the bean to retrieve the merged definition for- Returns:
- a (potentially merged) BeanDefinition for the given bean
- Throws:
NoSuchBeanDefinitionException
- if there is no bean definition with the given name- Since:
- 2.5
-
isFactoryBean
Determine whether the bean with the given name is a FactoryBean.- Parameters:
name
- the name of the bean to check- Returns:
- whether the bean is a FactoryBean
(
false
means the bean exists but is not a FactoryBean) - Throws:
NoSuchBeanDefinitionException
- if there is no bean with the given name- Since:
- 2.5
-
setCurrentlyInCreation
Explicitly control the current in-creation status of the specified bean. For container-internal use only.- Parameters:
beanName
- the name of the beaninCreation
- whether the bean is currently in creation- Since:
- 3.1
-
isCurrentlyInCreation
Determine whether the specified bean is currently in creation.- Parameters:
beanName
- the name of the bean- Returns:
- whether the bean is currently in creation
- Since:
- 2.5
-
registerDependentBean
Register a dependent bean for the given bean, to be destroyed before the given bean is destroyed.- Parameters:
beanName
- the name of the beandependentBeanName
- the name of the dependent bean- Since:
- 2.5
-
getDependentBeans
Return the names of all beans which depend on the specified bean, if any.- Parameters:
beanName
- the name of the bean- Returns:
- the array of dependent bean names, or an empty array if none
- Since:
- 2.5
-
getDependenciesForBean
Return the names of all beans that the specified bean depends on, if any.- Parameters:
beanName
- the name of the bean- Returns:
- the array of names of beans which the bean depends on, or an empty array if none
- Since:
- 2.5
-
destroyBean
Destroy the given bean instance (usually a prototype instance obtained from this factory) according to its bean definition.Any exception that arises during destruction should be caught and logged instead of propagated to the caller of this method.
- Parameters:
beanName
- the name of the bean definitionbeanInstance
- the bean instance to destroy
-
destroyScopedBean
Destroy the specified scoped bean in the current target scope, if any.Any exception that arises during destruction should be caught and logged instead of propagated to the caller of this method.
- Parameters:
beanName
- the name of the scoped bean
-
destroySingletons
void destroySingletons()Destroy all singleton beans in this factory, including inner beans that have been registered as disposable. To be called on shutdown of a factory.Any exception that arises during destruction should be caught and logged instead of propagated to the caller of this method.
-