| org.springframework.aop.framework.Advised
All known Subclasses: org.springframework.aop.framework.AdvisedSupport,
| Advised | | public interface Advised extends TargetClassAware(Code) | | Interface to be implemented by classes that hold the configuration
of a factory of AOP proxies. This configuration includes the
Interceptors and other advice, and Advisors, and the proxied interfaces.
Any AOP proxy obtained from Spring can be cast to this interface to
allow manipulation of its AOP advice.
author:
Rod Johnson
author:
Juergen Hoeller
since:
13.03.2003
See Also: org.springframework.aop.framework.AdvisedSupport |
| Method Summary | |
| void | addAdvice(Advice advice)
Add the given AOP Alliance advice to the tail of the advice (interceptor) chain. | | void | addAdvice(int pos, Advice advice)
Add the given AOP Alliance Advice at the specified position in the advice 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.
Parameters:
advisor - the advisor to add at the specified position in the chain
Parameters:
pos - position in chain (0 is head). | | Advisor[] | getAdvisors()
Return the advisors applying to this proxy. | | Class[] | getProxiedInterfaces()
Return the interfaces proxied by the AOP 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 | isExposeProxy()
Return whether the factory should expose the proxy as a ThreadLocal.
This can be necessary if a target object needs to invoke a method on itself
benefitting from advice. | | boolean | isFrozen()
Return whether the Advised configuration is frozen,
in which case no advice changes can be made. | | boolean | isInterfaceProxied(Class intf)
Determine whether the given interface is proxied. | | boolean | isProxyTargetClass()
| | boolean | removeAdvice(Advice advice)
Remove the Advisor containing the given advice. | | boolean | removeAdvisor(Advisor advisor)
Remove the given advisor. | | void | removeAdvisor(int index)
Remove the advisor at the given index. | | boolean | replaceAdvisor(Advisor a, Advisor b)
Replace the given advisor.
Note: If the advisor is an
org.springframework.aop.IntroductionAdvisor and 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.
Parameters:
a - the advisor to replace
Parameters:
b - the advisor to replace it with whether it was replaced. | | 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 | 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. |
| addAdvice | | void addAdvice(Advice advice) throws AopConfigException(Code) | | Add 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.
Parameters:
advice - advice to add to the tail of the chain
throws:
AopConfigException - in case of invalid advice
See Also: Advised.addAdvice(int,Advice)
See Also: org.springframework.aop.support.DefaultPointcutAdvisor |
| addAdvice | | void addAdvice(int pos, Advice advice) throws AopConfigException(Code) | | Add the given AOP Alliance Advice at the specified position in the advice chain.
This will be wrapped in a
org.springframework.aop.support.DefaultPointcutAdvisor with a pointcut that always applies, and returned from the
Advised.getAdvisors() method in this wrapped form.
Note: 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.
Parameters:
pos - index from 0 (head)
Parameters:
advice - advice to add at the specified position in the advice chain
throws:
AopConfigException - in case of invalid advice |
| addAdvisor | | void addAdvisor(int pos, Advisor advisor) throws AopConfigException(Code) | | Add an Advisor at the specified position in the chain.
Parameters:
advisor - the advisor to add at the specified position in the chain
Parameters:
pos - position in chain (0 is head). Must be valid.
throws:
AopConfigException - in case of invalid advice |
| getAdvisors | | Advisor[] getAdvisors()(Code) | | Return the advisors applying to this proxy.
a list of Advisors applying to this proxy (never null) |
| getProxiedInterfaces | | Class[] getProxiedInterfaces()(Code) | | Return the interfaces proxied by the AOP proxy. Will not
include the target class, which may also be proxied.
|
| getTargetSource | | TargetSource getTargetSource()(Code) | | Return the TargetSource used by this Advised object.
|
| indexOf | | int indexOf(Advisor advisor)(Code) | | Return 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.
Parameters:
advisor - the advisor to search for index from 0 of this advisor, or -1 if there's no such advisor |
| indexOf | | int indexOf(Advice advice)(Code) | | Return 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.
Parameters:
advice - AOP Alliance advice to search for index from 0 of this advice, or -1 if there's no such advice |
| isExposeProxy | | boolean isExposeProxy()(Code) | | Return whether the factory should expose the proxy as a ThreadLocal.
This can be necessary if a target object needs to invoke a method on itself
benefitting from advice. (If it invokes a method on this no advice
will apply.) Getting the proxy is analogous to an EJB calling getEJBObject().
See Also: AopContext |
| isFrozen | | boolean isFrozen()(Code) | | Return whether the Advised configuration is frozen,
in which case no advice changes can be made.
|
| isInterfaceProxied | | boolean isInterfaceProxied(Class intf)(Code) | | Determine whether the given interface is proxied.
Parameters:
intf - the interface to check |
| isProxyTargetClass | | boolean isProxyTargetClass()(Code) | | Are we proxying the full target class instead of specified interfaces?
|
| removeAdvice | | boolean removeAdvice(Advice advice)(Code) | | Remove the Advisor containing the given advice.
Parameters:
advice - the advice to remove true of the advice was found and removed;false if there was no such advice |
| removeAdvisor | | boolean removeAdvisor(Advisor advisor)(Code) | | Remove the given advisor.
Parameters:
advisor - the advisor to remove true if the advisor was removed; falseif the advisor was not found and hence could not be removed |
| removeAdvisor | | void removeAdvisor(int index) throws AopConfigException(Code) | | Remove the advisor at the given index.
Parameters:
index - index of advisor to remove
throws:
AopConfigException - if the index is invalid |
| replaceAdvisor | | boolean replaceAdvisor(Advisor a, Advisor b) throws AopConfigException(Code) | | Replace the given advisor.
Note: If the advisor is an
org.springframework.aop.IntroductionAdvisor and 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.
Parameters:
a - the advisor to replace
Parameters:
b - the advisor to replace it with whether it was replaced. If the advisor wasn't found in thelist of advisors, this method returns false and does nothing.
throws:
AopConfigException - in case of invalid advice |
| setExposeProxy | | void setExposeProxy(boolean exposeProxy)(Code) | | Set whether the proxy should be exposed by the AOP framework as a
ThreadLocal for retrieval via the AopContext class. This is useful
if an advised object needs to call another advised method on itself.
(If it uses this, the invocation will not be advised).
Default is "false", for optimal performance.
|
| setTargetSource | | void setTargetSource(TargetSource targetSource)(Code) | | Change the TargetSource used by this Advised object.
Only works if the configuration isn't frozen.
Parameters:
targetSource - new TargetSource to use |
| toProxyConfigString | | String toProxyConfigString()(Code) | | As toString() will normally be delegated to the target,
this returns the equivalent for the AOP proxy.
a string description of the proxy configuration |
|
|