Class AdvisedSupport
- java.lang.Object
- org.springframework.aop.framework.ProxyConfig
- org.springframework.aop.framework.AdvisedSupport
- All Implemented Interfaces:
Serializable,Advised,TargetClassAware
- Direct Known Subclasses:
ProxyCreatorSupport
public class AdvisedSupport extends ProxyConfig implements Advised
Base class for AOP proxy configuration managers. These are not themselves AOP proxies, but subclasses of this class are normally factories from which AOP proxy instances are obtained directly.This class frees subclasses of the housekeeping of Advices and Advisors, but doesn't actually implement proxy creation methods, which are provided by subclasses.
This class is serializable; subclasses need not be. This class is used to hold snapshots of proxies.
- Author:
- Rod Johnson, Juergen Hoeller
- See Also:
AopProxy, Serialized Form
Field Summary
Fields Modifier and Type Field Description static TargetSourceEMPTY_TARGET_SOURCECanonical TargetSource when there's no target, and behavior is supplied by the advisors.
Constructor Summary
Constructors Constructor Description AdvisedSupport()No-arg constructor for use as a JavaBean.AdvisedSupport(Class<?>... interfaces)Create a AdvisedSupport instance with the given parameters.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddAdvice(int pos, Advice advice)Cannot add introductions this way unless the advice implements IntroductionInfo.voidaddAdvice(Advice advice)Add the given AOP Alliance advice to the tail of the advice (interceptor) chain.voidaddAdvisor(int pos, Advisor advisor)Add an Advisor at the specified position in the chain.voidaddAdvisor(Advisor advisor)Add an advisor at the end of the advisor chain.voidaddAdvisors(Collection<Advisor> advisors)Add all of the given advisors to this proxy configuration.voidaddAdvisors(Advisor... advisors)Add all of the given advisors to this proxy configuration.voidaddInterface(Class<?> intf)Add a new proxied interface.protected voidadviceChanged()Invoked when advice has changed.booleanadviceIncluded(Advice advice)Is the given advice included in any advisor within this proxy configuration?protected voidcopyConfigurationFrom(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.protected voidcopyConfigurationFrom(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.intcountAdvicesOfType(Class<?> adviceClass)Count advices of the given class.AdvisorChainFactorygetAdvisorChainFactory()Return the advisor chain factory to use (nevernull).Advisor[]getAdvisors()Return the advisors applying to this proxy.protected List<Advisor>getAdvisorsInternal()List<Object>getInterceptorsAndDynamicInterceptionAdvice(Method method, Class<?> targetClass)Determine a list ofMethodInterceptorobjects 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).TargetSourcegetTargetSource()Return theTargetSourceused by thisAdvisedobject.intindexOf(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.intindexOf(Advisor advisor)Return the index (from 0) of the given advisor, or -1 if no such advisor applies to this proxy.booleanisInterfaceProxied(Class<?> intf)Determine whether the given interface is proxied.booleanisPreFiltered()Return whether this proxy configuration is pre-filtered so that it only contains applicable advisors (matching this proxy's target class).booleanremoveAdvice(Advice advice)Remove the Advisor containing the given advice.voidremoveAdvisor(int index)Remove the advisor at the given index.booleanremoveAdvisor(Advisor advisor)Remove the given advisor.booleanremoveInterface(Class<?> intf)Remove a proxied interface.booleanreplaceAdvisor(Advisor a, Advisor b)Replace the given advisor.voidsetAdvisorChainFactory(AdvisorChainFactory advisorChainFactory)Set the advisor chain factory to use.voidsetInterfaces(Class<?>... interfaces)Set the interfaces to be proxied.voidsetPreFiltered(boolean preFiltered)Set whether this proxy configuration is pre-filtered so that it only contains applicable advisors (matching this proxy's target class).voidsetTarget(Object target)Set the given object as target.voidsetTargetClass(Class<?> targetClass)Set a target class to be proxied, indicating that the proxy should be castable to the given class.voidsetTargetSource(TargetSource targetSource)Change theTargetSourceused by thisAdvisedobject.StringtoProxyConfigString()AstoString()will normally be delegated to the target, this returns the equivalent for the AOP proxy.StringtoString()For debugging/diagnostic use.protected voidupdateAdvisorArray()Bring the array up to date with the list.Methods inherited from class org.springframework.aop.framework.ProxyConfig
copyFrom, isExposeProxy, isFrozen, isOpaque, isOptimize, isProxyTargetClass, setExposeProxy, setFrozen, setOpaque, setOptimize, setProxyTargetClass
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.aop.framework.Advised
isExposeProxy, isFrozen, isProxyTargetClass, setExposeProxy
Field Detail
EMPTY_TARGET_SOURCE
public static final TargetSource EMPTY_TARGET_SOURCE
Canonical TargetSource when there's no target, and behavior is supplied by the advisors.
Constructor Detail
AdvisedSupport
public AdvisedSupport()
No-arg constructor for use as a JavaBean.
AdvisedSupport
public AdvisedSupport(Class<?>... interfaces)
Create a AdvisedSupport instance with the given parameters.- Parameters:
interfaces- the proxied interfaces
Method Detail
setTarget
public void setTarget(Object target)
Set the given object as target. Will create a SingletonTargetSource for the object.
setTargetSource
public void setTargetSource(TargetSource targetSource)
Description copied from interface:Advised- Specified by:
setTargetSourcein interfaceAdvised- Parameters:
targetSource- new TargetSource to use
getTargetSource
public TargetSource getTargetSource()
Description copied from interface:AdvisedReturn theTargetSourceused by thisAdvisedobject.- Specified by:
getTargetSourcein interfaceAdvised
setTargetClass
public void setTargetClass(Class<?> targetClass)
Set a target class to be proxied, indicating that the proxy should be castable to the given class.Internally, an
EmptyTargetSourcefor the given target class will be used. The kind of proxy needed will be determined on actual creation of the proxy.This is a replacement for setting a "targetSource" or "target", for the case where we want a proxy based on a target class (which can be an interface or a concrete class) without having a fully capable TargetSource available.
getTargetClass
public Class<?> getTargetClass()
Description copied from interface:TargetClassAwareReturn the target class behind the implementing object (typically a proxy configuration or an actual proxy).- Specified by:
getTargetClassin interfaceTargetClassAware- Returns:
- the target Class, or
nullif not known
setPreFiltered
public void setPreFiltered(boolean preFiltered)
Description copied from interface:AdvisedSet whether this proxy configuration is pre-filtered so that it only contains applicable advisors (matching this proxy's target class).Default is "false". Set this to "true" if the advisors have been pre-filtered already, meaning that the ClassFilter check can be skipped when building the actual advisor chain for proxy invocations.
- Specified by:
setPreFilteredin interfaceAdvised- See Also:
ClassFilter
isPreFiltered
public boolean isPreFiltered()
Description copied from interface:AdvisedReturn whether this proxy configuration is pre-filtered so that it only contains applicable advisors (matching this proxy's target class).- Specified by:
isPreFilteredin interfaceAdvised
setAdvisorChainFactory
public void setAdvisorChainFactory(AdvisorChainFactory advisorChainFactory)
Set the advisor chain factory to use.Default is a
DefaultAdvisorChainFactory.
getAdvisorChainFactory
public AdvisorChainFactory getAdvisorChainFactory()
Return the advisor chain factory to use (nevernull).
setInterfaces
public void setInterfaces(Class<?>... interfaces)
Set the interfaces to be proxied.
addInterface
public void addInterface(Class<?> intf)
Add a new proxied interface.- Parameters:
intf- the additional interface to proxy
removeInterface
public boolean removeInterface(Class<?> intf)
Remove a proxied interface.Does nothing if the given interface isn't proxied.
- Parameters:
intf- the interface to remove from the proxy- Returns:
trueif the interface was removed;falseif the interface was not found and hence could not be removed
getProxiedInterfaces
public Class<?>[] getProxiedInterfaces()
Description copied from interface:AdvisedReturn the interfaces proxied by the AOP proxy.Will not include the target class, which may also be proxied.
- Specified by:
getProxiedInterfacesin interfaceAdvised
isInterfaceProxied
public boolean isInterfaceProxied(Class<?> intf)
Description copied from interface:AdvisedDetermine whether the given interface is proxied.- Specified by:
isInterfaceProxiedin interfaceAdvised- Parameters:
intf- the interface to check
getAdvisors
public final Advisor[] getAdvisors()
Description copied from interface:AdvisedReturn the advisors applying to this proxy.- Specified by:
getAdvisorsin interfaceAdvised- Returns:
- a list of Advisors applying to this proxy (never
null)
addAdvisor
public void addAdvisor(Advisor advisor)
Description copied from interface:AdvisedAdd an advisor at the end of the advisor chain.The Advisor may be an
IntroductionAdvisor, in which new interfaces will be available when a proxy is next obtained from the relevant factory.- Specified by:
addAdvisorin interfaceAdvised- Parameters:
advisor- the advisor to add to the end of the chain
addAdvisor
public void addAdvisor(int pos, Advisor advisor) throws AopConfigException
Description copied from interface:AdvisedAdd an Advisor at the specified position in the chain.- Specified by:
addAdvisorin interfaceAdvised- Parameters:
pos- position in chain (0 is head). Must be valid.advisor- the advisor to add at the specified position in the chain- Throws:
AopConfigException- in case of invalid advice
removeAdvisor
public boolean removeAdvisor(Advisor advisor)
Description copied from interface:AdvisedRemove the given advisor.- Specified by:
removeAdvisorin interfaceAdvised- Parameters:
advisor- the advisor to remove- Returns:
trueif the advisor was removed;falseif the advisor was not found and hence could not be removed
removeAdvisor
public void removeAdvisor(int index) throws AopConfigException
Description copied from interface:AdvisedRemove the advisor at the given index.- Specified by:
removeAdvisorin interfaceAdvised- Parameters:
index- index of advisor to remove- Throws:
AopConfigException- if the index is invalid
indexOf
public int indexOf(Advisor advisor)
Description copied from interface:AdvisedReturn the index (from 0) of the given advisor, or -1 if no such advisor applies to this proxy.The return value of this method can be used to index into the advisors array.
replaceAdvisor
public boolean replaceAdvisor(Advisor a, Advisor b) throws AopConfigException
Description copied from interface:AdvisedReplace the given advisor.Note: If the advisor is an
IntroductionAdvisorand the replacement is not or implements different interfaces, the proxy will need to be re-obtained or the old interfaces won't be supported and the new interface won't be implemented.- Specified by:
replaceAdvisorin interfaceAdvised- Parameters:
a- the advisor to replaceb- the advisor to replace it with- Returns:
- whether it was replaced. If the advisor wasn't found in the list of advisors, this method returns
falseand does nothing. - Throws:
AopConfigException- in case of invalid advice
addAdvisors
public void addAdvisors(Advisor... advisors)
Add all of the given advisors to this proxy configuration.- Parameters:
advisors- the advisors to register
addAdvisors
public void addAdvisors(Collection<Advisor> advisors)
Add all of the given advisors to this proxy configuration.- Parameters:
advisors- the advisors to register
updateAdvisorArray
protected final void updateAdvisorArray()
Bring the array up to date with the list.
getAdvisorsInternal
protected final List<Advisor> getAdvisorsInternal()
Allows uncontrolled access to theListofAdvisors.Use with care, and remember to
refresh the advisor arrayandfire advice changed eventswhen making any modifications.
addAdvice
public void addAdvice(Advice advice) throws AopConfigException
Description copied from interface:AdvisedAdd the given AOP Alliance advice to the tail of the advice (interceptor) chain.This will be wrapped in a DefaultPointcutAdvisor with a pointcut that always applies, and returned from the
getAdvisors()method in this wrapped form.Note that the given advice will apply to all invocations on the proxy, even to the
toString()method! Use appropriate advice implementations or specify appropriate pointcuts to apply to a narrower set of methods.- Specified by:
addAdvicein interfaceAdvised- Parameters:
advice- advice to add to the tail of the chain- Throws:
AopConfigException- in case of invalid advice- See Also:
Advised.addAdvice(int, Advice),DefaultPointcutAdvisor
addAdvice
public void addAdvice(int pos, Advice advice) throws AopConfigException
Cannot add introductions this way unless the advice implements IntroductionInfo.- Specified by:
addAdvicein interfaceAdvised- Parameters:
pos- index from 0 (head)advice- advice to add at the specified position in the advice chain- Throws:
AopConfigException- in case of invalid advice
removeAdvice
public boolean removeAdvice(Advice advice) throws AopConfigException
Description copied from interface:AdvisedRemove the Advisor containing the given advice.- Specified by:
removeAdvicein interfaceAdvised- Parameters:
advice- the advice to remove- Returns:
trueof the advice was found and removed;falseif there was no such advice- Throws:
AopConfigException
indexOf
public int indexOf(Advice advice)
Description copied from interface:AdvisedReturn the index (from 0) of the given AOP Alliance Advice, or -1 if no such advice is an advice for this proxy.The return value of this method can be used to index into the advisors array.
adviceIncluded
public boolean adviceIncluded(Advice advice)
Is the given advice included in any advisor within this proxy configuration?- Parameters:
advice- the advice to check inclusion of- Returns:
- whether this advice instance is included
countAdvicesOfType
public int countAdvicesOfType(Class<?> adviceClass)
Count advices of the given class.- Parameters:
adviceClass- the advice class to check- Returns:
- the count of the interceptors of this class or subclasses
getInterceptorsAndDynamicInterceptionAdvice
public List<Object> getInterceptorsAndDynamicInterceptionAdvice(Method method, Class<?> targetClass)
Determine a list ofMethodInterceptorobjects for the given method, based on this configuration.- Parameters:
method- the proxied methodtargetClass- the target class- Returns:
- a List of MethodInterceptors (may also include InterceptorAndDynamicMethodMatchers)
adviceChanged
protected void adviceChanged()
Invoked when advice has changed.
copyConfigurationFrom
protected 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.- Parameters:
other- the AdvisedSupport object to copy configuration from
copyConfigurationFrom
protected 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.- Parameters:
other- the AdvisedSupport object to take proxy configuration fromtargetSource- the new TargetSourceadvisors- the Advisors for the chain
toProxyConfigString
public String toProxyConfigString()
Description copied from interface:AdvisedAstoString()will normally be delegated to the target, this returns the equivalent for the AOP proxy.- Specified by:
toProxyConfigStringin interfaceAdvised- Returns:
- a string description of the proxy configuration
toString
public String toString()
For debugging/diagnostic use.- Overrides:
toStringin classProxyConfig