public Interface ConfigurableBeanFactory

Scope identifier for the standard prototype scope: prototype.

Custom scopes can be added via registerScope.

See Also

registerScope

Scope identifier for the standard singleton scope: singleton.

Custom scopes can be added via registerScope.

See Also

registerScope

Add a new BeanPostProcessor that will get applied to beans created by this factory. To be invoked during factory configuration.

Parameters

beanPostProcessor:BeanPostProcessor

the post-processor to register

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

Parameters

valueResolver:StringValueResolver

the String resolver to apply to embedded values

Since

3.0

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.

Parameters

registrar:PropertyEditorRegistrar

the PropertyEditorRegistrar to register

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:ConfigurableBeanFactory

the other BeanFactory to copy from

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

Parameters

registry:PropertyEditorRegistry

the PropertyEditorRegistry to initialize

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:String

the name of the bean definition

beanInstance:Object

the bean instance to destroy

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:String

the name of the scoped bean

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.

Return the ApplicationStartup for this bean factory.

Since

5.3

Return this factory's class loader for loading bean classes (only null if even the system ClassLoader isn't accessible).

Annotations

@Nullable

See Also

org.springframework.util.ClassUtils#forName(String, ClassLoader)

Return the resolution strategy for expressions in bean definition values.

Annotations

@Nullable

Since

3.0

Return the current number of registered BeanPostProcessors, if any.

Return the associated ConversionService, if any.

Annotations

@Nullable

Since

3.0

Return the names of all beans that the specified bean depends on, if any.

Parameters

beanName:String

the name of the bean

Returns:String[]

the array of names of beans which the bean depends on, or an empty array if none

Since

2.5

Return the names of all beans which depend on the specified bean, if any.

Parameters

beanName:String

the name of the bean

Returns:String[]

the array of dependent bean names, or an empty array if none

Since

2.5

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:String

the name of the bean to retrieve the merged definition for

Returns:BeanDefinition

a (potentially merged) BeanDefinition for the given bean

Exceptions

NoSuchBeanDefinitionException:

if there is no bean definition with the given name

Since

2.5

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:String

the name of the scope

Returns:Scope

the registered Scope implementation, or null if none

Annotations

@Nullable

See Also

registerScope

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:String[]

the array of scope names, or an empty array if none

See Also

registerScope

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

Annotations

@Nullable

Since

2.5

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

Determine whether an embedded value resolver has been registered with this bean factory, to be applied through resolveEmbeddedValue(String).

Since

4.3

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

Determine whether the specified bean is currently in creation.

Parameters

beanName:String

the name of the bean

Returns:boolean

whether the bean is currently in creation

Since

2.5

Determine whether the bean with the given name is a FactoryBean.

Parameters

name:String

the name of the bean to check

Returns:boolean

whether the bean is a FactoryBean (false means the bean exists but is not a FactoryBean)

Exceptions

NoSuchBeanDefinitionException:

if there is no bean with the given name

Since

2.5

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:String

the canonical name of the target bean

alias:String

the alias to be registered for the bean

Exceptions

BeanDefinitionStoreException:

if the alias is already in use

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

Parameters

requiredType:Class<?>

type of the property

propertyEditorClass:Class<? extends PropertyEditor>

the PropertyEditor class to register

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

Parameters

beanName:String

the name of the bean

dependentBeanName:String

the name of the dependent bean

Since

2.5

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

Parameters

scopeName:String

the scope identifier

scope:Scope

the backing Scope implementation

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:StringValueResolver

the StringValueResolver to apply

Since

2.5

Resolve the given embedded value, e.g. an annotation attribute.

Parameters

value:String

the value to resolve

Returns:String

the resolved value (may be the original value as-is)

Annotations

@Nullable

Since

3.0

Set the ApplicationStartup for this bean factory.

This allows the application context to record metrics during application startup.

Parameters

applicationStartup:ApplicationStartup

the new application startup

Since

5.3

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:ClassLoader

the class loader to use, or null to suggest the default class loader

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

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.

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

Since

3.0

Explicitly control the current in-creation status of the specified bean. For container-internal use only.

Parameters

beanName:String

the name of the bean

inCreation:boolean

whether the bean is currently in creation

Since

3.1

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:BeanFactory

the parent BeanFactory

Exceptions

IllegalStateException:

if this factory is already associated with a parent BeanFactory

See Also

getParentBeanFactory()

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

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.

Since

2.5

See Also

addPropertyEditorRegistrar, registerCustomEditor