public interface

ConfigurableBeanFactory

implements HierarchicalBeanFactory SingletonBeanRegistry
org.springframework.beans.factory.config.ConfigurableBeanFactory
Known Indirect Subclasses

Class Overview

Configuration interface to be implemented by most bean factories. Provides facilities to configure a bean factory, in addition to the bean factory client methods in the 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.

Summary

Constants
String SCOPE_PROTOTYPE Scope identifier for the standard prototype scope: "prototype".
String SCOPE_SINGLETON Scope identifier for the standard singleton scope: "singleton".
[Expand]
Inherited Constants
From interface org.springframework.beans.factory.BeanFactory
Public Methods
abstract void addBeanPostProcessor(BeanPostProcessor beanPostProcessor)
Add a new BeanPostProcessor that will get applied to beans created by this factory.
abstract void addEmbeddedValueResolver(StringValueResolver valueResolver)
Add a String resolver for embedded values such as annotation attributes.
abstract void addPropertyEditorRegistrar(PropertyEditorRegistrar registrar)
Add a PropertyEditorRegistrar to be applied to all bean creation processes.
abstract void copyConfigurationFrom(ConfigurableBeanFactory otherFactory)
Copy all relevant configuration from the given other factory.
abstract void copyRegisteredEditorsTo(PropertyEditorRegistry registry)
Initialize the given PropertyEditorRegistry with the custom editors that have been registered with this BeanFactory.
abstract void destroyBean(String beanName, Object beanInstance)
Destroy the given bean instance (usually a prototype instance obtained from this factory) according to its bean definition.
abstract void destroyScopedBean(String beanName)
Destroy the specified scoped bean in the current target scope, if any.
abstract void destroySingletons()
Destroy all singleton beans in this factory, including inner beans that have been registered as disposable.
abstract AccessControlContext getAccessControlContext()
Provides a security access control context relevant to this factory.
abstract ClassLoader getBeanClassLoader()
Return this factory's class loader for loading bean classes.
abstract BeanExpressionResolver getBeanExpressionResolver()
Return the resolution strategy for expressions in bean definition values.
abstract int getBeanPostProcessorCount()
Return the current number of registered BeanPostProcessors, if any.
abstract ConversionService getConversionService()
Return the associated ConversionService, if any.
abstract String[] getDependenciesForBean(String beanName)
Return the names of all beans that the specified bean depends on, if any.
abstract String[] getDependentBeans(String beanName)
Return the names of all beans which depend on the specified bean, if any.
abstract BeanDefinition getMergedBeanDefinition(String beanName)
Return a merged BeanDefinition for the given bean name, merging a child bean definition with its parent if necessary.
abstract Scope getRegisteredScope(String scopeName)
Return the Scope implementation for the given scope name, if any.
abstract String[] getRegisteredScopeNames()
Return the names of all currently registered scopes.
abstract ClassLoader getTempClassLoader()
Return the temporary ClassLoader to use for type matching purposes, if any.
abstract TypeConverter getTypeConverter()
Obtain a type converter as used by this BeanFactory.
abstract boolean isCacheBeanMetadata()
Return whether to cache bean metadata such as given bean definitions (in merged fashion) and resolved bean classes.
abstract boolean isCurrentlyInCreation(String beanName)
Determine whether the specified bean is currently in creation.
abstract boolean isFactoryBean(String name)
Determine whether the bean with the given name is a FactoryBean.
abstract void registerAlias(String beanName, String alias)
Given a bean name, create an alias.
abstract void registerCustomEditor(Class<?> requiredType, Class<? extends PropertyEditor> propertyEditorClass)
Register the given custom property editor for all properties of the given type.
abstract void registerDependentBean(String beanName, String dependentBeanName)
Register a dependent bean for the given bean, to be destroyed before the given bean is destroyed.
abstract void registerScope(String scopeName, Scope scope)
Register the given scope, backed by the given Scope implementation.
abstract void resolveAliases(StringValueResolver valueResolver)
Resolve all alias target names and aliases registered in this factory, applying the given StringValueResolver to them.
abstract String resolveEmbeddedValue(String value)
Resolve the given embedded value, e.g.
abstract void setBeanClassLoader(ClassLoader beanClassLoader)
Set the class loader to use for loading bean classes.
abstract void setBeanExpressionResolver(BeanExpressionResolver resolver)
Specify the resolution strategy for expressions in bean definition values.
abstract void setCacheBeanMetadata(boolean cacheBeanMetadata)
Set whether to cache bean metadata such as given bean definitions (in merged fashion) and resolved bean classes.
abstract void setConversionService(ConversionService conversionService)
Specify a Spring 3.0 ConversionService to use for converting property values, as an alternative to JavaBeans PropertyEditors.
abstract void setParentBeanFactory(BeanFactory parentBeanFactory)
Set the parent of this bean factory.
abstract void setTempClassLoader(ClassLoader tempClassLoader)
Specify a temporary ClassLoader to use for type matching purposes.
abstract void setTypeConverter(TypeConverter typeConverter)
Set a custom type converter that this BeanFactory should use for converting bean property values, constructor argument values, etc.
[Expand]
Inherited Methods
From interface org.springframework.beans.factory.BeanFactory
From interface org.springframework.beans.factory.HierarchicalBeanFactory
From interface org.springframework.beans.factory.config.SingletonBeanRegistry

Constants

public static final String SCOPE_PROTOTYPE

Also: SpringBeans

Scope identifier for the standard prototype scope: "prototype". Custom scopes can be added via registerScope.

Constant Value: "prototype"

public static final String SCOPE_SINGLETON

Also: SpringBeans

Scope identifier for the standard singleton scope: "singleton". Custom scopes can be added via registerScope.

Constant Value: "singleton"

Public Methods

public abstract void addBeanPostProcessor (BeanPostProcessor beanPostProcessor)

Also: SpringBeans

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

public abstract void addEmbeddedValueResolver (StringValueResolver valueResolver)

Add a String resolver for embedded values such as annotation attributes.

Parameters
valueResolver the String resolver to apply to embedded values

public abstract void addPropertyEditorRegistrar (PropertyEditorRegistrar registrar)

Also: SpringBeans

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(Class, Class).

Parameters
registrar the PropertyEditorRegistrar to register

public abstract void copyConfigurationFrom (ConfigurableBeanFactory otherFactory)

Also: SpringBeans

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

public abstract void copyRegisteredEditorsTo (PropertyEditorRegistry registry)

Also: SpringBeans

Initialize the given PropertyEditorRegistry with the custom editors that have been registered with this BeanFactory.

Parameters
registry the PropertyEditorRegistry to initialize

public abstract void destroyBean (String beanName, Object beanInstance)

Also: SpringBeans

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 definition
beanInstance the bean instance to destroy

public abstract void destroyScopedBean (String beanName)

Also: SpringBeans

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

public abstract void destroySingletons ()

Also: SpringBeans

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.

public abstract AccessControlContext getAccessControlContext ()

Also: SpringBeans

Provides a security access control context relevant to this factory.

Returns
  • the applicable AccessControlContext (never null)

public abstract ClassLoader getBeanClassLoader ()

Also: SpringBeans

Return this factory's class loader for loading bean classes.

public abstract BeanExpressionResolver getBeanExpressionResolver ()

Also: SpringBeans

Return the resolution strategy for expressions in bean definition values.

public abstract int getBeanPostProcessorCount ()

Also: SpringBeans

Return the current number of registered BeanPostProcessors, if any.

public abstract ConversionService getConversionService ()

Also: SpringBeans

Return the associated ConversionService, if any.

public abstract String[] getDependenciesForBean (String beanName)

Also: SpringBeans

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

public abstract String[] getDependentBeans (String beanName)

Also: SpringBeans

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

public abstract BeanDefinition getMergedBeanDefinition (String beanName)

Also: SpringBeans

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

public abstract Scope getRegisteredScope (String scopeName)

Also: SpringBeans

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

public abstract String[] getRegisteredScopeNames ()

Also: SpringBeans

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

public abstract ClassLoader getTempClassLoader ()

Also: SpringBeans

Return the temporary ClassLoader to use for type matching purposes, if any.

public abstract TypeConverter getTypeConverter ()

Also: SpringBeans

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.

public abstract boolean isCacheBeanMetadata ()

Also: SpringBeans

Return whether to cache bean metadata such as given bean definitions (in merged fashion) and resolved bean classes.

public abstract boolean isCurrentlyInCreation (String beanName)

Also: SpringBeans

Determine whether the specified bean is currently in creation.

Parameters
beanName the name of the bean
Returns
  • whether the bean is currently in creation

public abstract boolean isFactoryBean (String name)

Also: SpringBeans

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

public abstract void registerAlias (String beanName, String alias)

Also: SpringBeans

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 bean
alias the alias to be registered for the bean
Throws
BeanDefinitionStoreException if the alias is already in use

public abstract void registerCustomEditor (Class<?> requiredType, Class<? extends PropertyEditor> propertyEditorClass)

Also: SpringBeans

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(PropertyEditorRegistrar) instead of this method, to avoid for the need for synchronization on custom editors.

Parameters
requiredType type of the property
propertyEditorClass the PropertyEditor class to register

public abstract void registerDependentBean (String beanName, String dependentBeanName)

Also: SpringBeans

Register a dependent bean for the given bean, to be destroyed before the given bean is destroyed.

Parameters
beanName the name of the bean
dependentBeanName the name of the dependent bean

public abstract void registerScope (String scopeName, Scope scope)

Also: SpringBeans

Register the given scope, backed by the given Scope implementation.

Parameters
scopeName the scope identifier
scope the backing Scope implementation

public abstract void resolveAliases (StringValueResolver valueResolver)

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

public abstract String resolveEmbeddedValue (String value)

Also: SpringBeans

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)

public abstract void setBeanClassLoader (ClassLoader beanClassLoader)

Also: SpringBeans

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, or null to suggest the default class loader

public abstract void setBeanExpressionResolver (BeanExpressionResolver resolver)

Also: SpringBeans

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.

public abstract void setCacheBeanMetadata (boolean cacheBeanMetadata)

Also: SpringBeans

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.

public abstract void setConversionService (ConversionService conversionService)

Specify a Spring 3.0 ConversionService to use for converting property values, as an alternative to JavaBeans PropertyEditors.

public abstract void setParentBeanFactory (BeanFactory parentBeanFactory)

Also: SpringBeans

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

public abstract void setTempClassLoader (ClassLoader tempClassLoader)

Also: SpringBeans

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.

public abstract void setTypeConverter (TypeConverter typeConverter)

Also: SpringBeans

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.