public abstract class

AbstractBeanFactory

extends FactoryBeanRegistrySupport
implements ConfigurableBeanFactory
java.lang.Object
   ↳ org.springframework.core.SimpleAliasRegistry
     ↳ org.springframework.beans.factory.support.DefaultSingletonBeanRegistry
       ↳ org.springframework.beans.factory.support.FactoryBeanRegistrySupport
         ↳ org.springframework.beans.factory.support.AbstractBeanFactory
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Abstract base class for BeanFactory implementations, providing the full capabilities of the ConfigurableBeanFactory SPI. Does not assume a listable bean factory: can therefore also be used as base class for bean factory implementations which obtain bean definitions from some backend resource (where bean definition access is an expensive operation).

This class provides a singleton cache (through its base class DefaultSingletonBeanRegistry, singleton/prototype determination, FactoryBean handling, aliases, bean definition merging for child bean definitions, and bean destruction (DisposableBean interface, custom destroy methods). Furthermore, it can manage a bean factory hierarchy (delegating to the parent in case of an unknown bean), through implementing the HierarchicalBeanFactory interface.

The main template methods to be implemented by subclasses are getBeanDefinition(String) and createBean(String, RootBeanDefinition, Object[]), retrieving a bean definition for a given bean name and creating a bean instance for a given bean definition, respectively. Default implementations of those operations can be found in DefaultListableBeanFactory and AbstractAutowireCapableBeanFactory.

Summary

[Expand]
Inherited Constants
From interface org.springframework.beans.factory.BeanFactory
From interface org.springframework.beans.factory.config.ConfigurableBeanFactory
[Expand]
Inherited Fields
From class org.springframework.beans.factory.support.DefaultSingletonBeanRegistry
Public Constructors
AbstractBeanFactory()
Create a new AbstractBeanFactory.
AbstractBeanFactory(BeanFactory parentBeanFactory)
Create a new AbstractBeanFactory with the given parent.
Public Methods
void 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 addPropertyEditorRegistrar(PropertyEditorRegistrar registrar)
Add a PropertyEditorRegistrar to be applied to all bean creation processes.
boolean containsBean(String name)
Does this bean factory contain a bean with the given name? More specifically, is getBean(Class) able to obtain a bean instance for the given name?

Translates aliases back to the corresponding canonical bean name.

boolean containsLocalBean(String name)
Return whether the local bean factory contains a bean of the given name, ignoring beans defined in ancestor contexts.
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(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.
AccessControlContext getAccessControlContext()
Delegate the creation of the access control context to the SecurityContextProvider.
String[] getAliases(String name)
Return the aliases for the given name, if defined.
<T> T getBean(String name, Class<T> requiredType, Object... args)
Return an instance, which may be shared or independent, of the specified bean.
Object getBean(String name, Object... args)
Return an instance, which may be shared or independent, of the specified bean.
<T> T getBean(String name, Class<T> requiredType)
Return an instance, which may be shared or independent, of the specified bean.
Object getBean(String name)
Return an instance, which may be shared or independent, of the specified bean.
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.
List<BeanPostProcessor> getBeanPostProcessors()
Return the list of BeanPostProcessors that will get applied to beans created with this factory.
ConversionService getConversionService()
Return the associated ConversionService, if any.
Map<ClassClass<? extends PropertyEditor>> getCustomEditors()
Return the map of custom editors, with Classes as keys and PropertyEditor classes as values.
BeanDefinition getMergedBeanDefinition(String name)
Return a 'merged' BeanDefinition for the given bean name, merging a child bean definition with its parent if necessary.
BeanFactory getParentBeanFactory()
Return the parent bean factory, or null if there is none.
Set<PropertyEditorRegistrar> getPropertyEditorRegistrars()
Return the set of PropertyEditorRegistrars.
Scope getRegisteredScope(String scopeName)
Return the Scope implementation for the given scope name, if any.
String[] getRegisteredScopeNames()
Return the names of all currently registered scopes.
ClassLoader getTempClassLoader()
Return the temporary ClassLoader to use for type matching purposes, if any.
Class<?> getType(String name)
Determine the type of the bean with the given name.
TypeConverter getTypeConverter()
Obtain a type converter as used by this BeanFactory.
boolean isBeanNameInUse(String beanName)
Determine whether the given bean name is already in use within this factory, i.e.
boolean isCacheBeanMetadata()
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.
boolean isPrototype(String name)
Is this bean a prototype? That is, will getBean(Class) always return independent instances?

Note: This method returning false does not clearly indicate a singleton object.

boolean isSingleton(String name)
Is this bean a shared singleton? That is, will getBean(Class) always return the same instance?

Note: This method returning false does not clearly indicate independent instances.

boolean isTypeMatch(String name, Class targetType)
void registerCustomEditor(Class<?> requiredType, Class<? extends PropertyEditor> propertyEditorClass)
Register the given custom property editor for all properties of the given type.
void registerScope(String scopeName, Scope scope)
Register the given scope, backed by the given Scope implementation.
String resolveEmbeddedValue(String value)
Resolve the given embedded value, e.g.
void setBeanClassLoader(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 setConversionService(ConversionService conversionService)
Specify a Spring 3.0 ConversionService to use for converting property values, as an alternative to JavaBeans PropertyEditors.
void setParentBeanFactory(BeanFactory parentBeanFactory)
Set the parent of this bean factory.
void setSecurityContextProvider(SecurityContextProvider securityProvider)
Set the security context provider for 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.
Protected Methods
void afterPrototypeCreation(String beanName)
Callback after prototype creation.
void beforePrototypeCreation(String beanName)
Callback before prototype creation.
void checkMergedBeanDefinition(RootBeanDefinition mbd, String beanName, Object[] args)
Check the given merged bean definition, potentially throwing validation exceptions.
void clearMergedBeanDefinition(String beanName)
Remove the merged bean definition for the specified bean, recreating it on next access.
abstract boolean containsBeanDefinition(String beanName)
Check if this bean factory contains a bean definition with the given name.
abstract Object createBean(String beanName, RootBeanDefinition mbd, Object[] args)
Create a bean instance for the given bean definition.
void destroyBean(String beanName, Object beanInstance, RootBeanDefinition mbd)
Destroy the given bean instance (usually a prototype instance obtained from this factory) according to the given bean definition.
<T> T doGetBean(String name, Class<T> requiredType, Object[] args, boolean typeCheckOnly)
Return an instance, which may be shared or independent, of the specified bean.
Object evaluateBeanDefinitionString(String value, BeanDefinition beanDefinition)
Evaluate the given String as contained in a bean definition, potentially resolving it as an expression.
abstract BeanDefinition getBeanDefinition(String beanName)
Return the bean definition for the given bean name.
TypeConverter getCustomTypeConverter()
Return the custom TypeConverter to use, if any.
RootBeanDefinition getMergedBeanDefinition(String beanName, BeanDefinition bd)
Return a RootBeanDefinition for the given top-level bean, by merging with the parent if the given bean's definition is a child bean definition.
RootBeanDefinition getMergedBeanDefinition(String beanName, BeanDefinition bd, BeanDefinition containingBd)
Return a RootBeanDefinition for the given bean, by merging with the parent if the given bean's definition is a child bean definition.
RootBeanDefinition getMergedLocalBeanDefinition(String beanName)
Return a merged RootBeanDefinition, traversing the parent bean definition if the specified bean corresponds to a child bean definition.
Object getObjectForBeanInstance(Object beanInstance, String name, String beanName, RootBeanDefinition mbd)
Get the object for the given bean instance, either the bean instance itself or its created object in case of a FactoryBean.
Class getTypeForFactoryBean(String beanName, RootBeanDefinition mbd)
Determine the bean type for the given FactoryBean definition, as far as possible.
boolean hasDestructionAwareBeanPostProcessors()
Return whether this factory holds a DestructionAwareBeanPostProcessor that will get applied to singleton beans on shutdown.
boolean hasInstantiationAwareBeanPostProcessors()
Return whether this factory holds a InstantiationAwareBeanPostProcessor that will get applied to singleton beans on shutdown.
void initBeanWrapper(BeanWrapper bw)
Initialize the given BeanWrapper with the custom editors registered with this factory.
boolean isBeanEligibleForMetadataCaching(String beanName)
Determine whether the specified bean is eligible for having its bean definition metadata cached.
boolean isFactoryBean(String beanName, RootBeanDefinition mbd)
Check whether the given bean is defined as a FactoryBean.
final boolean isPrototypeCurrentlyInCreation(String beanName)
Return whether the specified prototype bean is currently in creation (within the current thread).
void markBeanAsCreated(String beanName)
Mark the specified bean as already created (or about to be created).
String originalBeanName(String name)
Determine the original bean name, resolving locally defined aliases to canonical names.
Class predictBeanType(String beanName, RootBeanDefinition mbd, Class... typesToMatch)
Predict the eventual bean type (of the processed bean instance) for the specified bean.
void registerCustomEditors(PropertyEditorRegistry registry)
Initialize the given PropertyEditorRegistry with the custom editors that have been registered with this BeanFactory.
void registerDisposableBeanIfNecessary(String beanName, Object bean, RootBeanDefinition mbd)
Add the given bean to the list of disposable beans in this factory, registering its DisposableBean interface and/or the given destroy method to be called on factory shutdown (if applicable).
boolean removeSingletonIfCreatedForTypeCheckOnly(String beanName)
Remove the singleton instance (if any) for the given bean name, but only if it hasn't been used for other purposes than type checking.
boolean requiresDestruction(Object bean, RootBeanDefinition mbd)
Determine whether the given bean requires destruction on shutdown.
Class resolveBeanClass(RootBeanDefinition mbd, String beanName, Class... typesToMatch)
Resolve the bean class for the specified bean definition, resolving a bean class name into a Class reference (if necessary) and storing the resolved Class in the bean definition for further use.
String transformedBeanName(String name)
Return the bean name, stripping out the factory dereference prefix if necessary, and resolving aliases to canonical names.
[Expand]
Inherited Methods
From class org.springframework.beans.factory.support.FactoryBeanRegistrySupport
From class org.springframework.beans.factory.support.DefaultSingletonBeanRegistry
From class org.springframework.core.SimpleAliasRegistry
From class java.lang.Object
From interface org.springframework.beans.factory.BeanFactory
From interface org.springframework.beans.factory.HierarchicalBeanFactory
From interface org.springframework.beans.factory.config.ConfigurableBeanFactory
From interface org.springframework.beans.factory.config.SingletonBeanRegistry
From interface org.springframework.core.AliasRegistry

Public Constructors

public AbstractBeanFactory ()

Also: SpringBeans

Create a new AbstractBeanFactory.

public AbstractBeanFactory (BeanFactory parentBeanFactory)

Also: SpringBeans

Create a new AbstractBeanFactory with the given parent.

Parameters
parentBeanFactory parent bean factory, or null if none
See Also

Public Methods

public 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 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 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 boolean containsBean (String name)

Also: SpringBeans

Does this bean factory contain a bean with the given name? More specifically, is getBean(Class) able to obtain a bean instance for the given name?

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Parameters
name the name of the bean to query
Returns
  • whether a bean with the given name is defined

public boolean containsLocalBean (String name)

Also: SpringBeans

Return whether the local bean factory contains a bean of the given name, ignoring beans defined in ancestor contexts.

This is an alternative to containsBean, ignoring a bean of the given name from an ancestor bean factory.

Parameters
name the name of the bean to query
Returns
  • whether a bean with the given name is defined in the local factory

public 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 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 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 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 AccessControlContext getAccessControlContext ()

Also: SpringBeans

Delegate the creation of the access control context to the SecurityContextProvider.

public String[] getAliases (String name)

Also: SpringBeans

Return the aliases for the given name, if defined.

Parameters
name the name to check for aliases
Returns
  • the aliases, or an empty array if none

public T getBean (String name, Class<T> requiredType, Object... args)

Also: SpringBeans

Return an instance, which may be shared or independent, of the specified bean.

Parameters
name the name of the bean to retrieve
requiredType the required type of the bean to retrieve
args arguments to use if creating a prototype using explicit arguments to a static factory method. It is invalid to use a non-null args value in any other case.
Returns
  • an instance of the bean
Throws
BeansException if the bean could not be created

public Object getBean (String name, Object... args)

Also: SpringBeans

Return an instance, which may be shared or independent, of the specified bean.

Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.

Parameters
name the name of the bean to retrieve
args arguments to use if creating a prototype using explicit arguments to a static factory method. It is invalid to use a non-null args value in any other case.
Returns
  • an instance of the bean

public T getBean (String name, Class<T> requiredType)

Also: SpringBeans

Return an instance, which may be shared or independent, of the specified bean.

Behaves the same as getBean(String), but provides a measure of type safety by throwing a BeanNotOfRequiredTypeException if the bean is not of the required type. This means that ClassCastException can't be thrown on casting the result correctly, as can happen with getBean(String).

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Parameters
name the name of the bean to retrieve
requiredType type the bean must match. Can be an interface or superclass of the actual class, or null for any match. For example, if the value is Object.class, this method will succeed whatever the class of the returned instance.
Returns
  • an instance of the bean

public Object getBean (String name)

Also: SpringBeans

Return an instance, which may be shared or independent, of the specified bean.

This method allows a Spring BeanFactory to be used as a replacement for the Singleton or Prototype design pattern. Callers may retain references to returned objects in the case of Singleton beans.

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Parameters
name the name of the bean to retrieve
Returns
  • an instance of the bean

public ClassLoader getBeanClassLoader ()

Also: SpringBeans

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

public BeanExpressionResolver getBeanExpressionResolver ()

Also: SpringBeans

Return the resolution strategy for expressions in bean definition values.

public int getBeanPostProcessorCount ()

Also: SpringBeans

Return the current number of registered BeanPostProcessors, if any.

public List<BeanPostProcessor> getBeanPostProcessors ()

Also: SpringBeans

Return the list of BeanPostProcessors that will get applied to beans created with this factory.

public ConversionService getConversionService ()

Also: SpringBeans

Return the associated ConversionService, if any.

public Map<ClassClass<? extends PropertyEditor>> getCustomEditors ()

Also: SpringBeans

Return the map of custom editors, with Classes as keys and PropertyEditor classes as values.

public BeanDefinition getMergedBeanDefinition (String name)

Also: SpringBeans

Return a 'merged' BeanDefinition for the given bean name, merging a child bean definition with its parent if necessary.

This getMergedBeanDefinition considers bean definition in ancestors as well.

Parameters
name the name of the bean to retrieve the merged definition for (may be an alias)
Returns
  • a (potentially merged) RootBeanDefinition for the given bean
Throws
NoSuchBeanDefinitionException if there is no bean with the given name
BeanDefinitionStoreException in case of an invalid bean definition
BeansException

public BeanFactory getParentBeanFactory ()

Also: SpringBeans

Return the parent bean factory, or null if there is none.

public Set<PropertyEditorRegistrar> getPropertyEditorRegistrars ()

Also: SpringBeans

Return the set of PropertyEditorRegistrars.

public 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 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 ClassLoader getTempClassLoader ()

Also: SpringBeans

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

public Class<?> getType (String name)

Also: SpringBeans

Determine the type of the bean with the given name. More specifically, determine the type of object that getBean(Class) would return for the given name.

For a FactoryBean, return the type of object that the FactoryBean creates, as exposed by getObjectType().

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Parameters
name the name of the bean to query
Returns
  • the type of the bean, or null if not determinable

public 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 boolean isBeanNameInUse (String beanName)

Also: SpringBeans

Determine whether the given bean name is already in use within this factory, i.e. whether there is a local bean or alias registered under this name or an inner bean created with this name.

Parameters
beanName the name to check

public boolean isCacheBeanMetadata ()

Also: SpringBeans

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

public 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 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)

public boolean isPrototype (String name)

Also: SpringBeans

Is this bean a prototype? That is, will getBean(Class) always return independent instances?

Note: This method returning false does not clearly indicate a singleton object. It indicates non-independent instances, which may correspond to a scoped bean as well. Use the isSingleton(String) operation to explicitly check for a shared singleton instance.

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Parameters
name the name of the bean to query
Returns
  • whether this bean will always deliver independent instances

public boolean isSingleton (String name)

Also: SpringBeans

Is this bean a shared singleton? That is, will getBean(Class) always return the same instance?

Note: This method returning false does not clearly indicate independent instances. It indicates non-singleton instances, which may correspond to a scoped bean as well. Use the isPrototype(String) operation to explicitly check for independent instances.

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Parameters
name the name of the bean to query
Returns
  • whether this bean corresponds to a singleton instance

public boolean isTypeMatch (String name, Class targetType)

Also: SpringBeans

public 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 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 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 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 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 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 void setConversionService (ConversionService conversionService)

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

public 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

public void setSecurityContextProvider (SecurityContextProvider securityProvider)

Also: SpringBeans

Set the security context provider for this bean factory. If a security manager is set, interaction with the user code will be executed using the privileged of the provided security context.

public 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 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.

Protected Methods

protected void afterPrototypeCreation (String beanName)

Also: SpringBeans

Callback after prototype creation.

The default implementation marks the prototype as not in creation anymore.

Parameters
beanName the name of the prototype that has been created

protected void beforePrototypeCreation (String beanName)

Also: SpringBeans

Callback before prototype creation.

The default implementation register the prototype as currently in creation.

Parameters
beanName the name of the prototype about to be created

protected void checkMergedBeanDefinition (RootBeanDefinition mbd, String beanName, Object[] args)

Also: SpringBeans

Check the given merged bean definition, potentially throwing validation exceptions.

Parameters
mbd the merged bean definition to check
beanName the name of the bean
args the arguments for bean creation, if any
Throws
BeanDefinitionStoreException in case of validation failure

protected void clearMergedBeanDefinition (String beanName)

Also: SpringBeans

Remove the merged bean definition for the specified bean, recreating it on next access.

Parameters
beanName the bean name to clear the merged definition for

protected abstract boolean containsBeanDefinition (String beanName)

Also: SpringBeans

Check if this bean factory contains a bean definition with the given name. Does not consider any hierarchy this factory may participate in. Invoked by containsBean when no cached singleton instance is found.

Depending on the nature of the concrete bean factory implementation, this operation might be expensive (for example, because of directory lookups in external registries). However, for listable bean factories, this usually just amounts to a local hash lookup: The operation is therefore part of the public interface there. The same implementation can serve for both this template method and the public interface method in that case.

Parameters
beanName the name of the bean to look for
Returns
  • if this bean factory contains a bean definition with the given name

protected abstract Object createBean (String beanName, RootBeanDefinition mbd, Object[] args)

Also: SpringBeans

Create a bean instance for the given bean definition. The bean definition will already have been merged with the parent definition in case of a child definition.

All the other methods in this class invoke this method, although beans may be cached after being instantiated by this method. All bean instantiation within this class is performed by this method.

Parameters
beanName the name of the bean
mbd the merged bean definition for the bean
args arguments to use if creating a prototype using explicit arguments to a static factory method. This parameter must be null except in this case.
Returns
  • a new instance of the bean
Throws
BeanCreationException if the bean could not be created

protected void destroyBean (String beanName, Object beanInstance, RootBeanDefinition mbd)

Also: SpringBeans

Destroy the given bean instance (usually a prototype instance obtained from this factory) according to the given bean definition.

Parameters
beanName the name of the bean definition
beanInstance the bean instance to destroy
mbd the merged bean definition

protected T doGetBean (String name, Class<T> requiredType, Object[] args, boolean typeCheckOnly)

Also: SpringBeans

Return an instance, which may be shared or independent, of the specified bean.

Parameters
name the name of the bean to retrieve
requiredType the required type of the bean to retrieve
args arguments to use if creating a prototype using explicit arguments to a static factory method. It is invalid to use a non-null args value in any other case.
typeCheckOnly whether the instance is obtained for a type check, not for actual use
Returns
  • an instance of the bean
Throws
BeansException if the bean could not be created

protected Object evaluateBeanDefinitionString (String value, BeanDefinition beanDefinition)

Also: SpringBeans

Evaluate the given String as contained in a bean definition, potentially resolving it as an expression.

Parameters
value the value to check
beanDefinition the bean definition that the value comes from
Returns
  • the resolved value

protected abstract BeanDefinition getBeanDefinition (String beanName)

Also: SpringBeans

Return the bean definition for the given bean name. Subclasses should normally implement caching, as this method is invoked by this class every time bean definition metadata is needed.

Depending on the nature of the concrete bean factory implementation, this operation might be expensive (for example, because of directory lookups in external registries). However, for listable bean factories, this usually just amounts to a local hash lookup: The operation is therefore part of the public interface there. The same implementation can serve for both this template method and the public interface method in that case.

Parameters
beanName the name of the bean to find a definition for
Returns
  • the BeanDefinition for this prototype name (never null)
Throws
NoSuchBeanDefinitionException if the bean definition cannot be resolved
BeansException in case of errors

protected TypeConverter getCustomTypeConverter ()

Also: SpringBeans

Return the custom TypeConverter to use, if any.

Returns
  • the custom TypeConverter, or null if none specified

protected RootBeanDefinition getMergedBeanDefinition (String beanName, BeanDefinition bd)

Also: SpringBeans

Return a RootBeanDefinition for the given top-level bean, by merging with the parent if the given bean's definition is a child bean definition.

Parameters
beanName the name of the bean definition
bd the original bean definition (Root/ChildBeanDefinition)
Returns
  • a (potentially merged) RootBeanDefinition for the given bean
Throws
BeanDefinitionStoreException in case of an invalid bean definition

protected RootBeanDefinition getMergedBeanDefinition (String beanName, BeanDefinition bd, BeanDefinition containingBd)

Also: SpringBeans

Return a RootBeanDefinition for the given bean, by merging with the parent if the given bean's definition is a child bean definition.

Parameters
beanName the name of the bean definition
bd the original bean definition (Root/ChildBeanDefinition)
containingBd the containing bean definition in case of inner bean, or null in case of a top-level bean
Returns
  • a (potentially merged) RootBeanDefinition for the given bean
Throws
BeanDefinitionStoreException in case of an invalid bean definition

protected RootBeanDefinition getMergedLocalBeanDefinition (String beanName)

Also: SpringBeans

Return a merged RootBeanDefinition, traversing the parent bean definition if the specified bean corresponds to a child bean definition.

Parameters
beanName the name of the bean to retrieve the merged definition for
Returns
  • a (potentially merged) RootBeanDefinition for the given bean
Throws
NoSuchBeanDefinitionException if there is no bean with the given name
BeanDefinitionStoreException in case of an invalid bean definition
BeansException

protected Object getObjectForBeanInstance (Object beanInstance, String name, String beanName, RootBeanDefinition mbd)

Also: SpringBeans

Get the object for the given bean instance, either the bean instance itself or its created object in case of a FactoryBean.

Parameters
beanInstance the shared bean instance
name name that may include factory dereference prefix
beanName the canonical bean name
mbd the merged bean definition
Returns
  • the object to expose for the bean

protected Class getTypeForFactoryBean (String beanName, RootBeanDefinition mbd)

Also: SpringBeans

Determine the bean type for the given FactoryBean definition, as far as possible. Only called if there is no singleton instance registered for the target bean already.

The default implementation creates the FactoryBean via getBean to call its getObjectType method. Subclasses are encouraged to optimize this, typically by just instantiating the FactoryBean but not populating it yet, trying whether its getObjectType method already returns a type. If no type found, a full FactoryBean creation as performed by this implementation should be used as fallback.

Parameters
beanName the name of the bean
mbd the merged bean definition for the bean
Returns
  • the type for the bean if determinable, or null else

protected boolean hasDestructionAwareBeanPostProcessors ()

Also: SpringBeans

Return whether this factory holds a DestructionAwareBeanPostProcessor that will get applied to singleton beans on shutdown.

protected boolean hasInstantiationAwareBeanPostProcessors ()

Also: SpringBeans

Return whether this factory holds a InstantiationAwareBeanPostProcessor that will get applied to singleton beans on shutdown.

protected void initBeanWrapper (BeanWrapper bw)

Also: SpringBeans

Initialize the given BeanWrapper with the custom editors registered with this factory. To be called for BeanWrappers that will create and populate bean instances.

The default implementation delegates to registerCustomEditors(PropertyEditorRegistry). Can be overridden in subclasses.

Parameters
bw the BeanWrapper to initialize

protected boolean isBeanEligibleForMetadataCaching (String beanName)

Also: SpringBeans

Determine whether the specified bean is eligible for having its bean definition metadata cached.

Parameters
beanName the name of the bean
Returns
  • true if the bean's metadata may be cached at this point already

protected boolean isFactoryBean (String beanName, RootBeanDefinition mbd)

Also: SpringBeans

Check whether the given bean is defined as a FactoryBean.

Parameters
beanName the name of the bean
mbd the corresponding bean definition

protected final boolean isPrototypeCurrentlyInCreation (String beanName)

Also: SpringBeans

Return whether the specified prototype bean is currently in creation (within the current thread).

Parameters
beanName the name of the bean

protected void markBeanAsCreated (String beanName)

Also: SpringBeans

Mark the specified bean as already created (or about to be created).

This allows the bean factory to optimize its caching for repeated creation of the specified bean.

Parameters
beanName the name of the bean

protected String originalBeanName (String name)

Also: SpringBeans

Determine the original bean name, resolving locally defined aliases to canonical names.

Parameters
name the user-specified name
Returns
  • the original bean name

protected Class predictBeanType (String beanName, RootBeanDefinition mbd, Class... typesToMatch)

Also: SpringBeans

Predict the eventual bean type (of the processed bean instance) for the specified bean. Called by getType(String) and isTypeMatch(String, Class). Does not need to handle FactoryBeans specifically, since it is only supposed to operate on the raw bean type.

This implementation is simplistic in that it is not able to handle factory methods and InstantiationAwareBeanPostProcessors. It only predicts the bean type correctly for a standard bean. To be overridden in subclasses, applying more sophisticated type detection.

Parameters
beanName the name of the bean
mbd the merged bean definition to determine the type for
typesToMatch the types to match in case of internal type matching purposes (also signals that the returned Class will never be exposed to application code)
Returns
  • the type of the bean, or null if not predictable

protected void registerCustomEditors (PropertyEditorRegistry registry)

Also: SpringBeans

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

To be called for BeanWrappers that will create and populate bean instances, and for SimpleTypeConverter used for constructor argument and factory method type conversion.

Parameters
registry the PropertyEditorRegistry to initialize

protected void registerDisposableBeanIfNecessary (String beanName, Object bean, RootBeanDefinition mbd)

Also: SpringBeans

Add the given bean to the list of disposable beans in this factory, registering its DisposableBean interface and/or the given destroy method to be called on factory shutdown (if applicable). Only applies to singletons.

Parameters
beanName the name of the bean
bean the bean instance
mbd the bean definition for the bean

protected boolean removeSingletonIfCreatedForTypeCheckOnly (String beanName)

Also: SpringBeans

Remove the singleton instance (if any) for the given bean name, but only if it hasn't been used for other purposes than type checking.

Parameters
beanName the name of the bean
Returns
  • true if actually removed, false otherwise

protected boolean requiresDestruction (Object bean, RootBeanDefinition mbd)

Also: SpringBeans

Determine whether the given bean requires destruction on shutdown.

The default implementation checks the DisposableBean interface as well as a specified destroy method and registered DestructionAwareBeanPostProcessors.

Parameters
bean the bean instance to check
mbd the corresponding bean definition

protected Class resolveBeanClass (RootBeanDefinition mbd, String beanName, Class... typesToMatch)

Also: SpringBeans

Resolve the bean class for the specified bean definition, resolving a bean class name into a Class reference (if necessary) and storing the resolved Class in the bean definition for further use.

Parameters
mbd the merged bean definition to determine the class for
beanName the name of the bean (for error handling purposes)
typesToMatch the types to match in case of internal type matching purposes (also signals that the returned Class will never be exposed to application code)
Returns
  • the resolved bean class (or null if none)
Throws
CannotLoadBeanClassException if we failed to load the class

protected String transformedBeanName (String name)

Also: SpringBeans

Return the bean name, stripping out the factory dereference prefix if necessary, and resolving aliases to canonical names.

Parameters
name the user-specified name
Returns
  • the transformed bean name