org.springframework.aop.framework
Interface Advised

All Known Implementing Classes:

AdvisedSupport, ProxyFactory, ProxyFactoryBean

public interface Advised

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.

Since:

13.03.2003

Author:

Rod Johnson

See Also:

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.
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.
boolean	isExposeProxy() Return whether the factory should expose the proxy as a ThreadLocal.
boolean	isFrozen() Return whether the Advised configuration is frozen, and no advice changes can be made.
boolean	isInterfaceProxied(Class intf) Return whether this interface is proxied.
boolean	isProxyTargetClass() Should we proxy the target class as well as any interfaces?
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.
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.

Method Detail

setTargetSource

void setTargetSource(TargetSource targetSource)

Change the TargetSource used by this Advised object. Only works if the configuration isn't frozen.

Parameters:

targetSource - new TargetSource to use

getTargetSource

TargetSource getTargetSource()

Return the TargetSource used by this Advised object.

setExposeProxy

void setExposeProxy(boolean exposeProxy)

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.

isExposeProxy

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. (If it invokes a method on this no advice will apply.) Getting the proxy is analogous to an EJB calling getEJBObject().

See Also:

AopContext

isProxyTargetClass

boolean isProxyTargetClass()

Should we proxy the target class as well as any interfaces? Can use this to force CGLIB proxying.

getAdvisors

Advisor[] getAdvisors()

Return the Advisors applying to this proxy.

Returns:

a list of Advisors applying to this proxy. Cannot return null, but may return the empty array.

getProxiedInterfaces

Class[] getProxiedInterfaces()

Return the interfaces proxied by the AOP proxy. Will not include the target class, which may also be proxied.

Returns:

the interfaces proxied by the AOP proxy

isInterfaceProxied

boolean isInterfaceProxied(Class intf)

Return whether this interface is proxied.

Parameters:

intf - interface to test

addAdvice

void addAdvice(Advice advice)
               throws AopConfigException

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

See Also:

addAdvice(int, Advice), DefaultPointcutAdvisor

addAdvice

void addAdvice(int pos,
               Advice advice)
               throws AopConfigException

Add the given AOP Alliance Advice at the specified position in the advice 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:

pos - index from 0 (head)

advice - advice to add at the specified position in the advice chain

Throws:

AopConfigException

addAdvisor

void addAdvisor(Advisor advisor)
                throws AopConfigException

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

Parameters:

advisor - Advisor to add to the end of the chain

Throws:

AopConfigException

addAdvisor

void addAdvisor(int pos,
                Advisor advisor)
                throws AopConfigException

Add an Advisor at the specified position in the chain.

Parameters:

advisor - advisor to add at the specified position in the chain

pos - position in chain (0 is head). Must be valid.

Throws:

AopConfigException

indexOf

int indexOf(Advisor advisor)

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 - advisor to search for

Returns:

index from 0 of this advisor, or -1 if there's no such advisor.

removeAdvisor

boolean removeAdvisor(Advisor advisor)
                      throws AopConfigException

Remove the given advisor.

Parameters:

advisor - advisor to remove

Returns:

true if the advisor was removed; false if the advisor was not found and hence could not be removed

Throws:

AopConfigException

removeAdvisor

void removeAdvisor(int index)
                   throws AopConfigException

Remove the advisor at the given index.

Parameters:

index - index of advisor to remove

Throws:

AopConfigException - if the index is invalid

removeAdvice

boolean removeAdvice(Advice advice)
                     throws AopConfigException

Remove the Advisor containing the given advice.

Parameters:

advice - advice to remove

Returns:

whether the Advice was found and removed (false if there was no such advice)

Throws:

AopConfigException

replaceAdvisor

boolean replaceAdvisor(Advisor a,
                       Advisor b)
                       throws AopConfigException

Replace the given advisor.

NB:If the advisor is an 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 - advisor to replace

b - advisor to replace it with

Returns:

whether it was replaced. If the advisor wasn't found in the list of advisors, this method returns false and does nothing.

Throws:

AopConfigException

isFrozen

boolean isFrozen()

Return whether the Advised configuration is frozen, and no advice changes can be made.

toProxyConfigString

String toProxyConfigString()

As toString() will normally be delegated to the target, this returns the equivalent for the AOP proxy.

Returns:

a string description of the proxy configuration