public class

ProxyFactoryBean

extends ProxyCreatorSupport
implements BeanClassLoaderAware BeanFactoryAware FactoryBean<T>

java.lang.Object
↳	org.springframework.aop.framework.ProxyConfig
	↳	org.springframework.aop.framework.AdvisedSupport
		↳	org.springframework.aop.framework.ProxyCreatorSupport
			↳	org.springframework.aop.framework.ProxyFactoryBean

Class Overview

FactoryBean implementation that builds an AOP proxy based on beans in Spring BeanFactory.

org.aopalliance.intercept.MethodInterceptor MethodInterceptors and Advisors are identified by a list of bean names in the current bean factory, specified through the "interceptorNames" property. The last entry in the list can be the name of a target bean or a TargetSource; however, it is normally preferable to use the "targetName"/"target"/"targetSource" properties instead.

Global interceptors and advisors can be added at the factory level. The specified ones are expanded in an interceptor list where an "xxx*" entry is included in the list, matching the given prefix with the bean names (e.g. "global*" would match both "globalBean1" and "globalBean2", "*" all defined interceptors). The matching interceptors get applied according to their returned order value, if they implement the Ordered interface.

Creates a JDK proxy when proxy interfaces are given, and a CGLIB proxy for the actual target class if not. Note that the latter will only work if the target class does not have final methods, as a dynamic subclass will be created at runtime.

It's possible to cast a proxy obtained from this factory to Advised, or to obtain the ProxyFactoryBean reference and programmatically manipulate it. This won't work for existing prototype references, which are independent. However, it will work for prototypes subsequently obtained from the factory. Changes to interception will work immediately on singletons (including existing references). However, to change interfaces or target it's necessary to obtain a new instance from the factory. This means that singleton instances obtained from the factory do not have the same object identity. However, they do have the same interceptors and target, and changing any reference will change all objects.

Summary

Constants
String	GLOBAL_SUFFIX	This suffix in a value in an interceptor list indicates to expand globals.

Fields
protected final Log	logger

[Expand]

Inherited Fields

From class org.springframework.aop.framework.AdvisedSupport

Public Constructors
	ProxyFactoryBean()

Public Methods
Object	getObject() Return a proxy.
Class<?>	getObjectType() Return the type of the proxy.
boolean	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.
void	setAdvisorAdapterRegistry(AdvisorAdapterRegistry advisorAdapterRegistry) Specify the AdvisorAdapterRegistry to use.
void	setAutodetectInterfaces(boolean autodetectInterfaces) Set whether to autodetect proxy interfaces if none specified.
void	setBeanClassLoader(ClassLoader classLoader) Callback that supplies the bean `class loader` to a bean instance.
void	setBeanFactory(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.
void	setFrozen(boolean frozen) Set whether this config should be frozen.
void	setInterceptorNames(String[] interceptorNames) Set the list of Advice/Advisor bean names.
void	setProxyClassLoader(ClassLoader classLoader) Set the ClassLoader to generate the proxy class in.
void	setProxyInterfaces(Class[] proxyInterfaces) Set the names of the interfaces we're proxying.
void	setSingleton(boolean singleton) Set the value of the singleton property.
void	setTargetName(String targetName) Set the name of the target bean.

Protected Methods
void	adviceChanged() Blow away and recache singleton on an advice change.
Class	createCompositeInterface(Class[] interfaces) Create a composite interface Class for the given interfaces, implementing the given interfaces in one single Class.
Object	getProxy(AopProxy aopProxy) Return the proxy object to expose.

[Expand]

Inherited Methods

From class org.springframework.aop.framework.ProxyCreatorSupport

From class org.springframework.aop.framework.AdvisedSupport

void	addAdvice(int pos, Advice advice) Cannot add introductions this way unless the advice implements IntroductionInfo.
void	addAdvice(Advice advice) Add the given AOP Alliance advice to the tail of the advice (interceptor) chain.
void	addAdvisor(Advisor advisor) Add an advisor at the end of the advisor chain.
void	addAdvisor(int pos, Advisor advisor) Add an Advisor at the specified position in the chain.
void	addAdvisors(Advisor... advisors) Add all of the given advisors to this proxy configuration.
void	addAdvisors(Collection<Advisor> advisors) Add all of the given advisors to this proxy configuration.
void	addAllAdvisors(Advisor[] advisors) This method is deprecated. as of Spring 3.0, in favor of `addAdvisors(Collection)`
void	addInterface(Class intf) Add a new proxied interface.
void	adviceChanged() Invoked when advice has changed.
boolean	adviceIncluded(Advice advice) Is the given advice included in any advisor within this proxy configuration?
void	copyConfigurationFrom(AdvisedSupport other, TargetSource targetSource, List<Advisor> advisors) Copy the AOP configuration from the given AdvisedSupport object, but allow substitution of a fresh TargetSource and a given interceptor chain.
void	copyConfigurationFrom(AdvisedSupport other) Call this method on a new instance created by the no-arg constructor to create an independent copy of the configuration from the given object.
int	countAdvicesOfType(Class adviceClass) Count advices of the given class.
AdvisorChainFactory	getAdvisorChainFactory() Return the advisor chain factory to use (never `null`).
final Advisor[]	getAdvisors() Return the advisors applying to this proxy.
final List<Advisor>	getAdvisorsInternal() Allows uncontrolled access to the `List` of `Advisors`.
List<Object>	getInterceptorsAndDynamicInterceptionAdvice(Method method, Class targetClass) Determine a list of org.aopalliance.intercept.MethodInterceptor objects for the given method, based on this configuration.
Class[]	getProxiedInterfaces() Return the interfaces proxied by the AOP proxy.
Class<?>	getTargetClass() Return the target class behind the implementing object (typically a proxy configuration or an actual proxy).
TargetSource	getTargetSource() Return the TargetSource used by this Advised object.
int	indexOf(Advisor advisor) Return the index (from 0) of the given advisor, or -1 if no such advisor applies to this proxy.
int	indexOf(Advice advice) Return the index (from 0) of the given AOP Alliance Advice, or -1 if no such advice is an advice for this proxy.
boolean	isInterfaceProxied(Class intf) Determine whether the given interface is proxied.
boolean	isPreFiltered() Return whether this proxy configuration is pre-filtered so that it only contains applicable advisors (matching this proxy's target class).
boolean	removeAdvice(Advice advice) Remove the Advisor containing the given advice.
void	removeAdvisor(int index) Remove the advisor at the given index.
boolean	removeAdvisor(Advisor advisor) Remove the given advisor.
boolean	removeInterface(Class intf) Remove a proxied interface.
boolean	replaceAdvisor(Advisor a, Advisor b) Replace the given advisor.
void	setAdvisorChainFactory(AdvisorChainFactory advisorChainFactory) Set the advisor chain factory to use.
void	setInterfaces(Class[] interfaces) Set the interfaces to be proxied.
void	setPreFiltered(boolean preFiltered) Set whether this proxy configuration is pre-filtered so that it only contains applicable advisors (matching this proxy's target class).
void	setTarget(Object target) Set the given object as target.
void	setTargetClass(Class targetClass) Set a target class to be proxied, indicating that the proxy should be castable to the given class.
void	setTargetSource(TargetSource targetSource) Change the TargetSource used by this Advised object.
String	toProxyConfigString() As `toString()` will normally be delegated to the target, this returns the equivalent for the AOP proxy.
String	toString() For debugging/diagnostic use.
final void	updateAdvisorArray() Bring the array up to date with the list.

From class org.springframework.aop.framework.ProxyConfig

void	copyFrom(ProxyConfig other) Copy configuration from the other config object.
boolean	isExposeProxy() Return whether the AOP proxy will expose the AOP proxy for each invocation.
boolean	isFrozen() Return whether the config is frozen, and no advice changes can be made.
boolean	isOpaque() Return whether proxies created by this configuration should be prevented from being cast to `Advised`.
boolean	isOptimize() Return whether proxies should perform aggressive optimizations.
boolean	isProxyTargetClass() Return whether to proxy the target class directly as well as any interfaces.
void	setExposeProxy(boolean exposeProxy) Set whether the proxy should be exposed by the AOP framework as a ThreadLocal for retrieval via the AopContext class.
void	setFrozen(boolean frozen) Set whether this config should be frozen.
void	setOpaque(boolean opaque) Set whether proxies created by this configuration should be prevented from being cast to `Advised` to query proxy status.
void	setOptimize(boolean optimize) Set whether proxies should perform aggressive optimizations.
void	setProxyTargetClass(boolean proxyTargetClass) Set whether to proxy the target class directly, instead of just proxying specific interfaces.
String	toString()

From class java.lang.Object

From interface org.springframework.aop.TargetClassAware

From interface org.springframework.aop.framework.Advised

abstract void	addAdvice(int pos, Advice advice) Add the given AOP Alliance Advice at the specified position in the advice chain.
abstract void	addAdvice(Advice advice) Add the given AOP Alliance advice to the tail of the advice (interceptor) chain.
abstract void	addAdvisor(Advisor advisor) Add an advisor at the end of the advisor chain.
abstract void	addAdvisor(int pos, Advisor advisor) Add an Advisor at the specified position in the chain.
abstract Advisor[]	getAdvisors() Return the advisors applying to this proxy.
abstract Class[]	getProxiedInterfaces() Return the interfaces proxied by the AOP proxy.
abstract TargetSource	getTargetSource() Return the TargetSource used by this Advised object.
abstract int	indexOf(Advisor advisor) Return the index (from 0) of the given advisor, or -1 if no such advisor applies to this proxy.
abstract int	indexOf(Advice advice) Return the index (from 0) of the given AOP Alliance Advice, or -1 if no such advice is an advice for this proxy.
abstract boolean	isExposeProxy() Return whether the factory should expose the proxy as a ThreadLocal.
abstract boolean	isFrozen() Return whether the Advised configuration is frozen, in which case no advice changes can be made.
abstract boolean	isInterfaceProxied(Class intf) Determine whether the given interface is proxied.
abstract boolean	isPreFiltered() Return whether this proxy configuration is pre-filtered so that it only contains applicable advisors (matching this proxy's target class).
abstract boolean	isProxyTargetClass() Are we proxying the full target class instead of specified interfaces?
abstract boolean	removeAdvice(Advice advice) Remove the Advisor containing the given advice.
abstract void	removeAdvisor(int index) Remove the advisor at the given index.
abstract boolean	removeAdvisor(Advisor advisor) Remove the given advisor.
abstract boolean	replaceAdvisor(Advisor a, Advisor b) Replace the given advisor.
abstract void	setExposeProxy(boolean exposeProxy) Set whether the proxy should be exposed by the AOP framework as a ThreadLocal for retrieval via the AopContext class.
abstract void	setPreFiltered(boolean preFiltered) Set whether this proxy configuration is pre-filtered so that it only contains applicable advisors (matching this proxy's target class).
abstract void	setTargetSource(TargetSource targetSource) Change the TargetSource used by this Advised object.
abstract String	toProxyConfigString() As `toString()` will normally be delegated to the target, this returns the equivalent for the AOP proxy.

From interface org.springframework.beans.factory.BeanClassLoaderAware

From interface org.springframework.beans.factory.BeanFactoryAware

From interface org.springframework.beans.factory.FactoryBean

Constants

public static final String GLOBAL_SUFFIX

This suffix in a value in an interceptor list indicates to expand globals.

Constant Value: "*"

Fields

protected final Log logger

Public Constructors

public ProxyFactoryBean ()

Public Methods

public Object getObject ()

Return a proxy. Invoked when clients obtain beans from this factory bean. Create an instance of the AOP proxy to be returned by this factory. The instance will be cached for a singleton, and create on each call to getObject() for a proxy.

Returns

a fresh AOP proxy reflecting the current state of this factory

Throws

BeansException

public Class<?> getObjectType ()

Return the type of the proxy. Will check the singleton instance if already created, else fall back to the proxy interface (in case of just a single one), the target bean type, or the TargetSource's target class.

Returns

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

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

Returns

whether the exposed object is a singleton

public void setAdvisorAdapterRegistry (AdvisorAdapterRegistry advisorAdapterRegistry)

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

public void setAutodetectInterfaces (boolean autodetectInterfaces)

Set whether to autodetect proxy interfaces if none specified.

Default is "true". Turn this flag off to create a CGLIB proxy for the full target class if no interfaces specified.

public void setBeanClassLoader (ClassLoader classLoader)

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 afterPropertiesSet() method or a custom init-method.

Parameters

classLoader	the owning class loader; may be `null` in which case a default `ClassLoader` must be used, for example the `ClassLoader` obtained via `getDefaultClassLoader()`

public void setBeanFactory (BeanFactory beanFactory)

Callback that supplies the owning factory to a bean instance.

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

Parameters

beanFactory	owning BeanFactory (never `null`). The bean can immediately call methods on the factory.

public void setFrozen (boolean frozen)

Set whether this config should be frozen.

When a config is frozen, no advice changes can be made. This is useful for optimization, and useful when we don't want callers to be able to manipulate configuration after casting to Advised.

public void setInterceptorNames (String[] interceptorNames)

Set the list of Advice/Advisor bean names. This must always be set to use this factory bean in a bean factory.

The referenced beans should be of type Interceptor, Advisor or Advice The last entry in the list can be the name of any bean in the factory. If it's neither an Advice nor an Advisor, a new SingletonTargetSource is added to wrap it. Such a target bean cannot be used if the "target" or "targetSource" or "targetName" property is set, in which case the "interceptorNames" array must contain only Advice/Advisor bean names.

NOTE: Specifying a target bean as final name in the "interceptorNames" list is deprecated and will be removed in a future Spring version. Use the "targetName" property instead.

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.

public void setProxyInterfaces (Class[] proxyInterfaces)

Set the names of the interfaces we're proxying. If no interface is given, a CGLIB for the actual class will be created.

This is essentially equivalent to the "setInterfaces" method, but mirrors TransactionProxyFactoryBean's "setProxyInterfaces".

Throws

ClassNotFoundException

public void setSingleton (boolean singleton)

Set the value of the singleton property. Governs whether this factory should always return the same proxy instance (which implies the same target) or whether it should return a new prototype instance, which implies that the target and interceptors may be new instances also, if they are obtained from prototype bean definitions. This allows for fine control of independence/uniqueness in the object graph.

public void setTargetName (String targetName)

Set the name of the target bean. This is an alternative to specifying the target name at the end of the "interceptorNames" array.

You can also specify a target object or a TargetSource object directly, via the "target"/"targetSource" property, respectively.

Protected Methods

protected void adviceChanged ()

Blow away and recache singleton on an advice change.

protected Class createCompositeInterface (Class[] interfaces)

Create a composite interface Class for the given interfaces, implementing the given interfaces in one single Class.

The default implementation builds a JDK proxy class for the given interfaces.

Parameters

interfaces	the interfaces to merge

Returns

the merged interface as Class

protected Object getProxy (AopProxy aopProxy)

Return the proxy object to expose.

The default implementation uses a getProxy call with the factory's bean class loader. Can be overridden to specify a custom class loader.

Parameters

aopProxy	the prepared AopProxy instance to get the proxy from

Returns

the proxy object to expose

Interfaces

Classes

Exceptions

ProxyFactoryBean

Class Overview

See Also

Summary

Constants

public static final String GLOBAL_SUFFIX

Fields

protected final Log logger

Public Constructors

public ProxyFactoryBean ()

Public Methods

public Object getObject ()

Returns

Throws

public Class<?> getObjectType ()

Returns

See Also

public boolean isSingleton ()

Returns

public void setAdvisorAdapterRegistry (AdvisorAdapterRegistry advisorAdapterRegistry)

See Also

public void setAutodetectInterfaces (boolean autodetectInterfaces)

See Also

public void setBeanClassLoader (ClassLoader classLoader)

Parameters

public void setBeanFactory (BeanFactory beanFactory)

Parameters

public void setFrozen (boolean frozen)

public void setInterceptorNames (String[] interceptorNames)

See Also

public void setProxyClassLoader (ClassLoader classLoader)

public void setProxyInterfaces (Class[] proxyInterfaces)

Throws

See Also

public void setSingleton (boolean singleton)

public void setTargetName (String targetName)

See Also

Protected Methods

protected void adviceChanged ()

protected Class createCompositeInterface (Class[] interfaces)

Parameters

Returns

See Also

protected Object getProxy (AopProxy aopProxy)

Parameters

Returns

See Also