Save This Page
Home » spring-framework-2.5.5-with-dependencies » org.springframework » beans » factory » config » [javadoc | source]
org.springframework.beans.factory.config
public interface: ConfigurableBeanFactory [javadoc | source]

All Implemented Interfaces:
    HierarchicalBeanFactory, SingletonBeanRegistry

All Known Implementing Classes:
    DefaultListableBeanFactory, AbstractAutowireCapableBeanFactory, AbstractBeanFactory, XmlBeanFactory, ConfigurableListableBeanFactory

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 org.springframework.beans.factory.BeanFactory interface.

This bean factory interface is not meant to be used in normal application code: Stick to org.springframework.beans.factory.BeanFactory or org.springframework.beans.factory.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.

Field Summary
 String SCOPE_SINGLETON    Scope identifier for the standard singleton scope: "singleton". Custom scopes can be added via registerScope. 
 String SCOPE_PROTOTYPE    Scope identifier for the standard prototype scope: "prototype". Custom scopes can be added via registerScope. 
Method from org.springframework.beans.factory.config.ConfigurableBeanFactory Summary:
addBeanPostProcessor,   addPropertyEditorRegistrar,   copyConfigurationFrom,   destroyBean,   destroyScopedBean,   destroySingletons,   getBeanClassLoader,   getBeanPostProcessorCount,   getDependenciesForBean,   getDependentBeans,   getMergedBeanDefinition,   getRegisteredScope,   getRegisteredScopeNames,   getTempClassLoader,   getTypeConverter,   isCacheBeanMetadata,   isCurrentlyInCreation,   isFactoryBean,   registerAlias,   registerCustomEditor,   registerCustomEditor,   registerDependentBean,   registerScope,   resolveAliases,   setBeanClassLoader,   setCacheBeanMetadata,   setParentBeanFactory,   setTempClassLoader,   setTypeConverter
Method from org.springframework.beans.factory.config.ConfigurableBeanFactory Detail:
 public  void addBeanPostProcessor(BeanPostProcessor beanPostProcessor)
    Add a new BeanPostProcessor that will get applied to beans created by this factory. To be invoked during factory configuration.
 public  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 .

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

 public  void destroyBean(String beanName,
    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.

 public  void destroyScopedBean(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.

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

 public ClassLoader getBeanClassLoader()
    Return this factory's class loader for loading bean classes.
 public int getBeanPostProcessorCount()
    Return the current number of registered BeanPostProcessors, if any.
 public String[] getDependenciesForBean(String beanName)
    Return the names of all beans that the specified bean depends on, if any.
 public String[] getDependentBeans(String beanName)
    Return the names of all beans which depend on the specified bean, if any.
 public BeanDefinition getMergedBeanDefinition(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.
 public Scope getRegisteredScope(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.

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

 public ClassLoader getTempClassLoader()
    Return the temporary ClassLoader to use for type matching purposes, if any.
 public 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.

 public boolean isCacheBeanMetadata()
    Return whether to cache bean metadata such as given bean definitions (in merged fashion) and resolved bean classes.
 public boolean isCurrentlyInCreation(String beanName)
    Determine whether the specified bean is currently in creation.
 public boolean isFactoryBean(String name) throws NoSuchBeanDefinitionException
    Determine whether the bean with the given name is a FactoryBean.
 public  void registerAlias(String beanName,
    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.

 public  void registerCustomEditor(Class requiredType,
    Class 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 instead of this method, to avoid for the need for synchronization on custom editors.

 public  void registerCustomEditor(Class requiredType,
    PropertyEditor propertyEditor)Deprecated! as -  of Spring 2.0.7, in favor of #addPropertyEditorRegistrar 
and #registerCustomEditor(Class, Class) 

    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.

 public  void registerDependentBean(String beanName,
    String dependentBeanName)
    Register a dependent bean for the given bean, to be destroyed before the given bean is destroyed.
 public  void registerScope(String scopeName,
    Scope scope)
    Register the given scope, backed by the given Scope implementation.
 public  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.

 public  void setBeanClassLoader(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.

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

 public  void setParentBeanFactory(BeanFactory parentBeanFactory) throws 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.

 public  void setTempClassLoader(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.

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