org.springframework.aop.framework
Interface Advised

All Known Implementing Classes:

AdvisedSupport

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 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-Mar-2003

Version:

$Id: Advised.java,v 1.12 2004/04/14 18:55:18 johnsonr Exp $

Author:

Rod Johnson

See Also:

AdvisedSupport

Method Summary

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	addAfterReturningAdvice(AfterReturningAdvice afterReturningAdvice) Add an AfterReturningAdvice to the tail of the advice chain
void	addBeforeAdvice(MethodBeforeAdvice beforeAdvice) Add a MethodBeforeAdvice to the tail of the advice chain
void	addInterceptor(org.aopalliance.intercept.Interceptor interceptor) Add the given AOP Alliance interceptor to the tail of the advice (interceptor) chain.
void	addInterceptor(int pos, org.aopalliance.intercept.Interceptor interceptor) Add the given AOP Alliance interceptor at the specified position in the interceptor chain.
void	addThrowsAdvice(ThrowsAdvice throwsAdvice) Add a ThrowsAdvice to the tail of the advice chain
Advisor[]	getAdvisors() Return the Advisors applying to this proxy.
boolean	getExposeProxy() Get whether the factory should expose the proxy as a ThreadLocal.
java.lang.Class[]	getProxiedInterfaces() Return the interfaces proxied by the AOP proxy.
boolean	getProxyTargetClass() Should we proxy the target class as well as any interfaces?
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	isFrozen()
boolean	isInterfaceProxied(java.lang.Class intf) Return whether this interface is proxied
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.
java.lang.String	toProxyConfigString() As toString() will normally pass to the target, this returns the equivalent for the AOP proxy

Method Detail

getTargetSource

public TargetSource getTargetSource()

Return the TargetSource used by this Advised object

Returns:

the TargetSource used by this advised object

getExposeProxy

public boolean getExposeProxy()

Get 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().

Returns:

whether the factory should expose the proxy as a ThreadLocal

See Also:

AopContext

getProxyTargetClass

public boolean getProxyTargetClass()

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

Returns:

whether we proxy the target class as well as any interfaces

getAdvisors

public 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

public java.lang.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

public boolean isInterfaceProxied(java.lang.Class intf)

Return whether this interface is proxied

Parameters:

intf - interface to test

Returns:

whether the interface is proxied

addInterceptor

public void addInterceptor(org.aopalliance.intercept.Interceptor interceptor)
                    throws AopConfigException

Add the given AOP Alliance interceptor to the tail of the advice (interceptor) chain. This will be wrapped in a DefaultPointcutAdvistor with a pointcut that always applies, and returned from the getAdvisors() method in this wrapped form.

Parameters:

interceptor - to add to the tail of the chain

Throws:

AopConfigException

See Also:

addInterceptor(int, Interceptor), DefaultPointcutAdvisor

addInterceptor

public void addInterceptor(int pos,
                           org.aopalliance.intercept.Interceptor interceptor)
                    throws AopConfigException

Add the given AOP Alliance interceptor at the specified position in the interceptor chain.

Parameters:

pos - index from 0 (head)

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

Throws:

AopConfigException

addAfterReturningAdvice

public void addAfterReturningAdvice(AfterReturningAdvice afterReturningAdvice)
                             throws AopConfigException

Add an AfterReturningAdvice to the tail of the advice chain

Parameters:

afterReturningAdvice - AfterReturningAdvice to add

Throws:

AopConfigException - if the advice cannot be added--for example, because the proxy configuration is frozen

addBeforeAdvice

public void addBeforeAdvice(MethodBeforeAdvice beforeAdvice)
                     throws AopConfigException

Add a MethodBeforeAdvice to the tail of the advice chain

Parameters:

beforeAdvice - MethodBeforeAdvice to add

Throws:

AopConfigException - if the advice cannot be added--for example, because the proxy configuration is frozen

addThrowsAdvice

public void addThrowsAdvice(ThrowsAdvice throwsAdvice)
                     throws AopConfigException

Add a ThrowsAdvice to the tail of the advice chain

Parameters:

throwsAdvice - ThrowsAdvice to add

Throws:

AopConfigException - if the advice cannot be added--for example, because the proxy configuration is frozen

addAdvisor

public 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

public 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

public 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

public 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

public 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

replaceAdvisor

public 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

public boolean isFrozen()

Returns:

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

toProxyConfigString

public java.lang.String toProxyConfigString()

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

Returns:

a string description of the proxy configuration