Package org.springframework.aop.framework

Class AbstractSingletonProxyFactoryBean

java.lang.Object
org.springframework.aop.framework.ProxyConfig
org.springframework.aop.framework.AbstractSingletonProxyFactoryBean
All Implemented Interfaces:
Serializable, Aware, BeanClassLoaderAware, FactoryBean<Object>, InitializingBean
Direct Known Subclasses:
CacheProxyFactoryBean, TransactionProxyFactoryBean
public abstract class AbstractSingletonProxyFactoryBean extends ProxyConfig implements FactoryBean<Object>, BeanClassLoaderAware, InitializingBean
Convenient superclass for FactoryBean types that produce singleton-scoped proxy objects.

Manages pre- and post-interceptors (references, rather than interceptor names, as in ProxyFactoryBean) and provides consistent interface management.

Since:
2.0
Author:
Juergen Hoeller
See Also:

  • Constructor Details

    • AbstractSingletonProxyFactoryBean

      public AbstractSingletonProxyFactoryBean()

  • Method Details

    • setTarget

      public void setTarget(Object target)
      Set the target object, that is, the bean to be wrapped with a transactional proxy.

      The target may be any object, in which case a SingletonTargetSource will be created. If it is a TargetSource, no wrapper TargetSource is created: This enables the use of a pooling or prototype TargetSource etc.

      See Also:

    • setProxyInterfaces

      public void setProxyInterfaces(Class<?>[] proxyInterfaces)
      Specify the set of interfaces being proxied.

      If not specified (the default), the AOP infrastructure works out which interfaces need proxying by analyzing the target, proxying all the interfaces that the target object implements.

    • setPreInterceptors

      public void setPreInterceptors(Object[] preInterceptors)
      Set additional interceptors (or advisors) to be applied before the implicit transaction interceptor, for example, a PerformanceMonitorInterceptor.

      You may specify any AOP Alliance MethodInterceptors or other Spring AOP Advices, as well as Spring AOP Advisors.

      See Also:

    • setPostInterceptors

      public void setPostInterceptors(Object[] postInterceptors)
      Set additional interceptors (or advisors) to be applied after the implicit transaction interceptor.

      You may specify any AOP Alliance MethodInterceptors or other Spring AOP Advices, as well as Spring AOP Advisors.

    • setAdvisorAdapterRegistry

      public void setAdvisorAdapterRegistry(AdvisorAdapterRegistry advisorAdapterRegistry)
      Specify the AdvisorAdapterRegistry to use. Default is the global AdvisorAdapterRegistry.
      See Also:

    • setProxyClassLoader

      public void setProxyClassLoader(ClassLoader classLoader)
      Set the ClassLoader to generate the proxy class in.

      Default is the bean ClassLoader, i.e. the ClassLoader used by the containing BeanFactory for loading all bean classes. This can be overridden here for specific proxies.

    • setBeanClassLoader

      public void setBeanClassLoader(ClassLoader classLoader)
      Description copied from interface: BeanClassLoaderAware
      Callback that supplies the bean class loader to a bean instance.

      Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean's InitializingBean.afterPropertiesSet() method or a custom init-method.

      Specified by:
      setBeanClassLoader in interface BeanClassLoaderAware
      Parameters:
      classLoader - the owning class loader

    • afterPropertiesSet

      public void afterPropertiesSet()
      Description copied from interface: InitializingBean
      Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

      This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

      Specified by:
      afterPropertiesSet in interface InitializingBean

    • createTargetSource

      protected TargetSource createTargetSource(Object target)
      Determine a TargetSource for the given target (or TargetSource).
      Parameters:
      target - the target. If this is an implementation of TargetSource it is used as our TargetSource; otherwise it is wrapped in a SingletonTargetSource.
      Returns:
      a TargetSource for this object

    • postProcessProxyFactory

      protected void postProcessProxyFactory(ProxyFactory proxyFactory)
      A hook for subclasses to post-process the ProxyFactory before creating the proxy instance with it.
      Parameters:
      proxyFactory - the AOP ProxyFactory about to be used
      Since:
      4.2

    • getObject

      public Object getObject()
      Description copied from interface: FactoryBean
      Return an instance (possibly shared or independent) of the object managed by this factory.

      As with a BeanFactory, this allows support for both the Singleton and Prototype design patterns.

      If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding FactoryBeanNotInitializedException.

      FactoryBeans are allowed to return null objects. The bean factory will consider this as a normal value to be used and will not throw a FactoryBeanNotInitializedException in this case. However, FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves, as appropriate.

      Specified by:
      getObject in interface FactoryBean<Object>
      Returns:
      an instance of the bean (can be null)
      See Also:

    • getObjectType

      public @Nullable Class<?> getObjectType()
      Description copied from interface: FactoryBean
      Return the type of object that this FactoryBean creates, or null if not known in advance.

      This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

      In the case of implementations that create a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

      This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

      NOTE: Autowiring will simply ignore FactoryBeans that return null here. Therefore, it is highly recommended to implement this method properly, using the current state of the FactoryBean.

      Specified by:
      getObjectType in interface FactoryBean<Object>
      Returns:
      the type of object that this FactoryBean creates, or null if not known at the time of the call
      See Also:

    • isSingleton

      public final boolean isSingleton()
      Description copied from interface: FactoryBean
      Is the object managed by this factory a singleton? That is, will FactoryBean.getObject() always return the same object (a reference that can be cached)?

      NOTE: If a FactoryBean indicates that it holds a singleton object, the object returned from getObject() might get cached by the owning BeanFactory. Hence, do not return true unless the FactoryBean always exposes the same reference.

      The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

      NOTE: This method returning false does not necessarily indicate that returned objects are independent instances. An implementation of the extended SmartFactoryBean interface may explicitly indicate independent instances through its SmartFactoryBean.isPrototype() method. Plain FactoryBean implementations which do not implement this extended interface are simply assumed to always return independent instances if the isSingleton() implementation returns false.

      The default implementation returns true, since a FactoryBean typically manages a singleton instance.

      Specified by:
      isSingleton in interface FactoryBean<Object>
      Returns:
      whether the exposed object is a singleton
      See Also:

    • createMainInterceptor

      protected abstract Object createMainInterceptor()
      Create the "main" interceptor for this proxy factory bean. Typically an Advisor, but can also be any type of Advice.

      Pre-interceptors will be applied before, post-interceptors will be applied after this interceptor.