Spring Framework 6.1.4 · org.springframework.aop.framework.AbstractSingletonProxyFactoryBean

Modifier and Type	Field and Description
private AdvisorAdapterRegistry	advisorAdapterRegistry Default is global AdvisorAdapterRegistry.
private Object[]	postInterceptors
private Object[]	preInterceptors
private Object	proxy
private transient ClassLoader	proxyClassLoader
private Class<?>[]	proxyInterfaces
private Object	target

Access	Constructor and Description
public	AbstractSingletonProxyFactoryBean()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. 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.
protected abstract Object	createMainInterceptor() Create the "main" interceptor for this proxy factory bean.
protected TargetSource	Returns: a TargetSource for this object createTargetSource(Object the target. If this is an implementation of TargetSource it is used as our TargetSource; otherwise it is wrapped in a SingletonTargetSource. target) Determine a TargetSource for the given target (or TargetSource).
public Object	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<?>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public final boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?
protected void	postProcessProxyFactory(ProxyFactory the AOP ProxyFactory about to be used proxyFactory) A hook for subclasses to post-process the `ProxyFactory` before creating the proxy instance with it.
public void	setAdvisorAdapterRegistry(AdvisorAdapterRegistry advisorAdapterRegistry) Specify the AdvisorAdapterRegistry to use.
public void	setBeanClassLoader(ClassLoader the owning class loader classLoader) Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Callback that supplies the bean `class loader` to a bean instance.
public void	setPostInterceptors(Object[] postInterceptors) Set additional interceptors (or advisors) to be applied after the implicit transaction interceptor.
public void	setPreInterceptors(Object[] preInterceptors) Set additional interceptors (or advisors) to be applied before the implicit transaction interceptor, e.g. a PerformanceMonitorInterceptor.
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.
public void	setProxyInterfaces(Class<?>[] proxyInterfaces) Specify the set of interfaces being proxied.
public void	setTarget(Object target) Set the target object, that is, the bean to be wrapped with a transactional proxy.

Inherited from org.springframework.aop.framework.ProxyConfig:: copyFrom isExposeProxy isFrozen isOpaque isOptimize isProxyTargetClass setExposeProxy setFrozen setOpaque setOptimize setProxyTargetClass toString

advisorAdapterRegistry	back to summary
private AdvisorAdapterRegistry advisorAdapterRegistry Default is global AdvisorAdapterRegistry.

postInterceptors	back to summary
private Object[] postInterceptors Annotations @Nullable

preInterceptors	back to summary
private Object[] preInterceptors Annotations @Nullable

proxy	back to summary
private Object proxy Annotations @Nullable

proxyClassLoader	back to summary
private transient ClassLoader proxyClassLoader Annotations @Nullable

proxyInterfaces	back to summary
private Class<?>[] proxyInterfaces Annotations @Nullable

target	back to summary
private Object target Annotations @Nullable

AbstractSingletonProxyFactoryBean	back to summary
public AbstractSingletonProxyFactoryBean()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. 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. Annotations @Override

public void afterPropertiesSet()

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

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.

Annotations

@Override

createMainInterceptor	back to summary
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.

createMainInterceptor

back to summary

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.

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

createTargetSource

back to summary

protected TargetSource createTargetSource(Object target)

Determine a TargetSource for the given target (or TargetSource).

Parameters

target:Object: the target. If this is an implementation of TargetSource it is used as our TargetSource; otherwise it is wrapped in a SingletonTargetSource.

Returns:TargetSource

a TargetSource for this object

getObject back to summary

getObject	back to summary
public Object getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. 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 pattern. 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`. As of Spring 2.0, FactoryBeans are allowed to return `null` objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate. Returns:Object an instance of the bean (can be `null`) Annotations @Override

public Object getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

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

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.

As of Spring 2.0, FactoryBeans are allowed to return null objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

Returns:Object

an instance of the bean (can be null)

Annotations

@Override

getObjectType back to summary

getObjectType	back to summary
public Class<?> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. 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 are creating 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. Returns:Class<?> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override @Nullable

public Class<?> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

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 are creating 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.

Returns:Class<?>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations

@Override
@Nullable

isSingleton back to summary

isSingleton	back to summary
public final boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? That is, will `getObject()` always return the same object (a reference that can be cached)? Note If a FactoryBean indicates to hold 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. Returns:boolean whether the exposed object is a singleton Annotations @Override

public final boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will getObject() always return the same object (a reference that can be cached)?

Note

If a FactoryBean indicates to hold 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.

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

postProcessProxyFactory back to summary

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

protected void postProcessProxyFactory(ProxyFactory proxyFactory)

A hook for subclasses to post-process the ProxyFactory before creating the proxy instance with it.

Parameters

proxyFactory:ProxyFactory: the AOP ProxyFactory about to be used

Since

4.2

setAdvisorAdapterRegistry back to summary

setAdvisorAdapterRegistry	back to summary
public void setAdvisorAdapterRegistry(AdvisorAdapterRegistry advisorAdapterRegistry) Specify the AdvisorAdapterRegistry to use. Default is the global AdvisorAdapterRegistry. See Also `org.springframework.aop.framework.adapter.GlobalAdvisorAdapterRegistry`

public void setAdvisorAdapterRegistry(AdvisorAdapterRegistry advisorAdapterRegistry)

Specify the AdvisorAdapterRegistry to use. Default is the global AdvisorAdapterRegistry.

See Also: org.springframework.aop.framework.adapter.GlobalAdvisorAdapterRegistry

setBeanClassLoader back to summary

setBeanClassLoader	back to summary
public void setBeanClassLoader(ClassLoader classLoader) Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. Doc from org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader. 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. Parameters classLoader:ClassLoader the owning class loader Annotations @Override

public void setBeanClassLoader(ClassLoader classLoader)

Implements org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader.

Doc from org.springframework.beans.factory.BeanClassLoaderAware.setBeanClassLoader.

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.

Parameters

classLoader:ClassLoader: the owning class loader

Annotations

@Override

setPostInterceptors	back to summary
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.

setPostInterceptors

back to summary

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.

setPreInterceptors back to summary

setPreInterceptors	back to summary
public void setPreInterceptors(Object[] preInterceptors) Set additional interceptors (or advisors) to be applied before the implicit transaction interceptor, e.g. a PerformanceMonitorInterceptor. You may specify any AOP Alliance MethodInterceptors or other Spring AOP Advices, as well as Spring AOP Advisors. See Also `org.springframework.aop.interceptor.PerformanceMonitorInterceptor`

public void setPreInterceptors(Object[] preInterceptors)

Set additional interceptors (or advisors) to be applied before the implicit transaction interceptor, e.g. a PerformanceMonitorInterceptor.

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

See Also: org.springframework.aop.interceptor.PerformanceMonitorInterceptor

setProxyClassLoader	back to summary
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.

setProxyClassLoader

back to summary

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.

setProxyInterfaces	back to summary
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.

setProxyInterfaces

back to summary

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.

setTarget back to summary

setTarget	back to summary
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 `org.springframework.aop.TargetSource`, `org.springframework.aop.target.SingletonTargetSource`, `org.springframework.aop.target.LazyInitTargetSource`, `org.springframework.aop.target.PrototypeTargetSource`, `org.springframework.aop.target.CommonsPool2TargetSource`

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: org.springframework.aop.TargetSource, org.springframework.aop.target.SingletonTargetSource, org.springframework.aop.target.LazyInitTargetSource, org.springframework.aop.target.PrototypeTargetSource, org.springframework.aop.target.CommonsPool2TargetSource

public abstract Class AbstractSingletonProxyFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail