org.springframework.beans.factory.config
Interface ConfigurableBeanFactory

All Superinterfaces:
BeanFactory, HierarchicalBeanFactory, SingletonBeanRegistry
All Known Subinterfaces:
ConfigurableListableBeanFactory
All Known Implementing Classes:
AbstractAutowireCapableBeanFactory, AbstractBeanFactory, DefaultListableBeanFactory, XmlBeanFactory

public interface ConfigurableBeanFactory
extends HierarchicalBeanFactory, SingletonBeanRegistry

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.

Since:
03.11.2003
Author:
Juergen Hoeller
See Also:
BeanFactory, ListableBeanFactory, ConfigurableListableBeanFactory

Field Summary
static java.lang.String SCOPE_PROTOTYPE
          Scope identifier for the standard prototype scope: "prototype".
static java.lang.String SCOPE_SINGLETON
          Scope identifier for the standard singleton scope: "singleton".
 
Fields inherited from interface org.springframework.beans.factory.BeanFactory
FACTORY_BEAN_PREFIX
 
Method Summary
 void addBeanPostProcessor(BeanPostProcessor beanPostProcessor)
          Add a new BeanPostProcessor that will get applied to beans created by this factory.
 void addPropertyEditorRegistrar(PropertyEditorRegistrar registrar)
          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 copyRegisteredEditorsTo(PropertyEditorRegistry registry)
          Initialize the given PropertyEditorRegistry with the custom editors that have been registered with this BeanFactory.
 void destroyBean(java.lang.String beanName, java.lang.Object beanInstance)
          Destroy the given bean instance (usually a prototype instance obtained from this factory) according to its bean definition.
 void destroyScopedBean(java.lang.String beanName)
          Destroy the specified scoped bean in the current target scope, if any.
 void destroySingletons()
          Destroy all singleton beans in this factory, including inner beans that have been registered as disposable.
 java.lang.ClassLoader getBeanClassLoader()
          Return this factory's class loader for loading bean classes.
 BeanExpressionResolver getBeanExpressionResolver()
          Return the resolution strategy for expressions in bean definition values.
 int getBeanPostProcessorCount()
          Return the current number of registered BeanPostProcessors, if any.
 java.lang.String[] getDependenciesForBean(java.lang.String beanName)
          Return the names of all beans that the specified bean depends on, if any.
 java.lang.String[] getDependentBeans(java.lang.String beanName)
          Return the names of all beans which depend on the specified bean, if any.
 BeanDefinition getMergedBeanDefinition(java.lang.String beanName)
          Return a merged BeanDefinition for the given bean name, merging a child bean definition with its parent if necessary.
 Scope getRegisteredScope(java.lang.String scopeName)
          Return the Scope implementation for the given scope name, if any.
 java.lang.String[] getRegisteredScopeNames()
          Return the names of all currently registered scopes.
 java.lang.ClassLoader getTempClassLoader()
          Return the temporary ClassLoader to use for type matching purposes, if any.
 TypeConverter getTypeConverter()
          Obtain a type converter as used by this BeanFactory.
 boolean isCacheBeanMetadata()
          Return whether to cache bean metadata such as given bean definitions (in merged fashion) and resolved bean classes.
 boolean isCurrentlyInCreation(java.lang.String beanName)
          Determine whether the specified bean is currently in creation.
 boolean isFactoryBean(java.lang.String name)
          Determine whether the bean with the given name is a FactoryBean.
 void registerAlias(java.lang.String beanName, java.lang.String alias)
          Given a bean name, create an alias.
 void registerCustomEditor(java.lang.Class requiredType, java.lang.Class<java.beans.PropertyEditor> propertyEditorClass)
          Register the given custom property editor for all properties of the given type.
 void registerDependentBean(java.lang.String beanName, java.lang.String dependentBeanName)
          Register a dependent bean for the given bean, to be destroyed before the given bean is destroyed.
 void registerScope(java.lang.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.
 void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)
          Set the class loader to use for loading bean classes.
 void setBeanExpressionResolver(BeanExpressionResolver resolver)
          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 setParentBeanFactory(BeanFactory parentBeanFactory)
          Set the parent of this bean factory.
 void setTempClassLoader(java.lang.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.HierarchicalBeanFactory
containsLocalBean, getParentBeanFactory
 
Methods inherited from interface org.springframework.beans.factory.BeanFactory
containsBean, getAliases, getBean, getBean, getBean, getType, isPrototype, isSingleton, isTypeMatch
 
Methods inherited from interface org.springframework.beans.factory.config.SingletonBeanRegistry
containsSingleton, getSingleton, getSingletonCount, getSingletonNames, registerSingleton
 

Field Detail

SCOPE_SINGLETON

static final java.lang.String SCOPE_SINGLETON
Scope identifier for the standard singleton scope: "singleton". Custom scopes can be added via registerScope.

See Also:
registerScope(java.lang.String, org.springframework.beans.factory.config.Scope), Constant Field Values

SCOPE_PROTOTYPE

static final java.lang.String SCOPE_PROTOTYPE
Scope identifier for the standard prototype scope: "prototype". Custom scopes can be added via registerScope.

See Also:
registerScope(java.lang.String, org.springframework.beans.factory.config.Scope), Constant Field Values
Method Detail

setParentBeanFactory

void setParentBeanFactory(BeanFactory parentBeanFactory)
                          throws java.lang.IllegalStateException
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:
java.lang.IllegalStateException - if this factory is already associated with a parent BeanFactory
See Also:
HierarchicalBeanFactory.getParentBeanFactory()

setBeanClassLoader

void setBeanClassLoader(java.lang.ClassLoader beanClassLoader)
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

getBeanClassLoader

java.lang.ClassLoader getBeanClassLoader()
Return this factory's class loader for loading bean classes.


setTempClassLoader

void setTempClassLoader(java.lang.ClassLoader tempClassLoader)
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.


getTempClassLoader

java.lang.ClassLoader getTempClassLoader()
Return the temporary ClassLoader to use for type matching purposes, if any.


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

void setBeanExpressionResolver(BeanExpressionResolver resolver)
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.


getBeanExpressionResolver

BeanExpressionResolver getBeanExpressionResolver()
Return the resolution strategy for expressions in bean definition values.


addPropertyEditorRegistrar

void addPropertyEditorRegistrar(PropertyEditorRegistrar registrar)
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).

Parameters:
registrar - the PropertyEditorRegistrar to register

registerCustomEditor

void registerCustomEditor(java.lang.Class requiredType,
                          java.lang.Class<java.beans.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 property
propertyEditorClass - the PropertyEditor class to register

copyRegisteredEditorsTo

void copyRegisteredEditorsTo(PropertyEditorRegistry registry)
Initialize the given PropertyEditorRegistry with the custom editors that have been registered with this BeanFactory.

Parameters:
registry - the PropertyEditorRegistry to initialize

setTypeConverter

void setTypeConverter(TypeConverter typeConverter)
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.

See Also:
addPropertyEditorRegistrar(org.springframework.beans.PropertyEditorRegistrar), registerCustomEditor(java.lang.Class, java.lang.Class)

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.


addBeanPostProcessor

void addBeanPostProcessor(BeanPostProcessor beanPostProcessor)
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

void registerScope(java.lang.String scopeName,
                   Scope scope)
Register the given scope, backed by the given Scope implementation.

Parameters:
scopeName - the scope identifier
scope - the backing Scope implementation

getRegisteredScopeNames

java.lang.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:
registerScope(java.lang.String, org.springframework.beans.factory.config.Scope)

getRegisteredScope

Scope getRegisteredScope(java.lang.String scopeName)
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:
registerScope(java.lang.String, org.springframework.beans.factory.config.Scope)

copyConfigurationFrom

void copyConfigurationFrom(ConfigurableBeanFactory otherFactory)
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

void registerAlias(java.lang.String beanName,
                   java.lang.String alias)
                   throws BeanDefinitionStoreException
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

resolveAliases

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

getMergedBeanDefinition

BeanDefinition getMergedBeanDefinition(java.lang.String beanName)
                                       throws NoSuchBeanDefinitionException
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

isFactoryBean

boolean isFactoryBean(java.lang.String name)
                      throws NoSuchBeanDefinitionException
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

isCurrentlyInCreation

boolean isCurrentlyInCreation(java.lang.String beanName)
Determine whether the specified bean is currently in creation.

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

registerDependentBean

void registerDependentBean(java.lang.String beanName,
                           java.lang.String dependentBeanName)
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

getDependentBeans

java.lang.String[] getDependentBeans(java.lang.String beanName)
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

getDependenciesForBean

java.lang.String[] getDependenciesForBean(java.lang.String beanName)
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

destroyBean

void destroyBean(java.lang.String beanName,
                 java.lang.Object beanInstance)
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

destroyScopedBean

void destroyScopedBean(java.lang.String beanName)
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.