Package org.springframework.beans.factory.config

Interface InstantiationAwareBeanPostProcessor

All Superinterfaces:
BeanPostProcessor
All Known Subinterfaces:
SmartInstantiationAwareBeanPostProcessor
All Known Implementing Classes:
AbstractAdvisingBeanPostProcessor, AbstractAdvisorAutoProxyCreator, AbstractAutoProxyCreator, AbstractBeanFactoryAwareAdvisingPostProcessor, AnnotationAwareAspectJAutoProxyCreator, AspectJAwareAdvisorAutoProxyCreator, AsyncAnnotationBeanPostProcessor, AutowiredAnnotationBeanPostProcessor, BeanNameAutoProxyCreator, CommonAnnotationBeanPostProcessor, DefaultAdvisorAutoProxyCreator, InfrastructureAdvisorAutoProxyCreator, MethodValidationPostProcessor, PersistenceAnnotationBeanPostProcessor, PersistenceExceptionTranslationPostProcessor, ScriptFactoryPostProcessor
public interface InstantiationAwareBeanPostProcessor extends BeanPostProcessor
Subinterface of BeanPostProcessor that adds a before-instantiation callback, and a callback after instantiation but before explicit properties are set or autowiring occurs.

Typically used to suppress default instantiation for specific target beans, for example to create proxies with special TargetSources (pooling targets, lazily initializing targets, etc), or to implement additional injection strategies such as field injection.

NOTE: This interface is a special purpose interface, mainly for internal use within the framework. It is recommended to implement the plain BeanPostProcessor interface as far as possible.

Since:
1.2
Author:
Juergen Hoeller, Rod Johnson
See Also:

  • Method Details

    • postProcessBeforeInstantiation

      @Nullable default Object postProcessBeforeInstantiation(Class<?> beanClass, String beanName) throws BeansException
      Apply this BeanPostProcessor before the target bean gets instantiated. The returned bean object may be a proxy to use instead of the target bean, effectively suppressing default instantiation of the target bean.

      If a non-null object is returned by this method, the bean creation process will be short-circuited. The only further processing applied is the BeanPostProcessor.postProcessAfterInitialization(java.lang.Object, java.lang.String) callback from the configured BeanPostProcessors.

      This callback will be applied to bean definitions with their bean class, as well as to factory-method definitions in which case the returned bean type will be passed in here.

      Post-processors may implement the extended SmartInstantiationAwareBeanPostProcessor interface in order to predict the type of the bean object that they are going to return here.

      The default implementation returns null.

      Parameters:
      beanClass - the class of the bean to be instantiated
      beanName - the name of the bean
      Returns:
      the bean object to expose instead of a default instance of the target bean, or null to proceed with default instantiation
      Throws:
      BeansException - in case of errors
      See Also:

    • postProcessAfterInstantiation

      default boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException
      Perform operations after the bean has been instantiated, via a constructor or factory method, but before Spring property population (from explicit properties or autowiring) occurs.

      This is the ideal callback for performing custom field injection on the given bean instance, right before Spring's autowiring kicks in.

      The default implementation returns true.

      Parameters:
      bean - the bean instance created, with properties not having been set yet
      beanName - the name of the bean
      Returns:
      true if properties should be set on the bean; false if property population should be skipped. Normal implementations should return true. Returning false will also prevent any subsequent InstantiationAwareBeanPostProcessor instances being invoked on this bean instance.
      Throws:
      BeansException - in case of errors
      See Also:

    • postProcessProperties

      @Nullable default PropertyValues postProcessProperties(PropertyValues pvs, Object bean, String beanName) throws BeansException
      Post-process the given property values before the factory applies them to the given bean.

      The default implementation returns the given pvs as-is.

      Parameters:
      pvs - the property values that the factory is about to apply (never null)
      bean - the bean instance created, but whose properties have not yet been set
      beanName - the name of the bean
      Returns:
      the actual property values to apply to the given bean (can be the passed-in PropertyValues instance), or null to skip property population
      Throws:
      BeansException - in case of errors
      Since:
      5.1