Modifier and Type	Class and Description
private static class	AbstractAspectJAdvice.AdviceExcludingMethodMatcher MethodMatcher that excludes the specified advice method.

Field Summary

Modifier and Type	Field and Description
private Map<String, Integer>	argumentBindings
private String[]	argumentNames This will be non-null if the creator of this advice object knows the argument names and sets them explicitly.
private boolean	argumentsIntrospected
private final AspectInstanceFactory	aspectInstanceFactory
protected transient Method	aspectJAdviceMethod
private String	aspectName The name of the aspect (ref bean) in which this advice was defined (used when determining advice precedence so that we can determine whether two pieces of advice come from the same aspect).
private int	declarationOrder The order of declaration of this advice within the aspect.
private final Class<?>	declaringClass
private Type	discoveredReturningGenericType
private Class<?>	discoveredReturningType
private Class<?>	discoveredThrowingType
protected static final String	JOIN_POINT_KEY Key used in ReflectiveMethodInvocation userAttributes map for the current joinpoint.
private int	joinPointArgumentIndex Index for thisJoinPoint argument (currently only supported at index 0 if present at all).
private int	joinPointStaticPartArgumentIndex Index for thisJoinPointStaticPart argument (currently only supported at index 0 if present at all).
private final String	methodName
private final Class<?>[]	parameterTypes
private final AspectJExpressionPointcut	pointcut
private String	returningName Non-null if after returning advice binds the return value.
private String	throwingName Non-null if after throwing advice binds the thrown value.

Constructor Summary

Access	Constructor and Description
public	AbstractAspectJAdvice(Method the AspectJ-style advice method aspectJAdviceMethod, AspectJExpressionPointcut the AspectJ expression pointcut pointcut, AspectInstanceFactory the factory for aspect instances aspectInstanceFactory) Create a new AbstractAspectJAdvice for the given advice method.

Method Summary

Modifier and Type	Method and Description
protected Object[]	Returns: the empty array if there are no arguments argBinding(JoinPoint the current JoinPoint jp, JoinPointMatch the join point match that matched this execution join point jpMatch, Object the return value from the method execution (may be null) returnValue, Throwable the exception thrown by the method execution (may be null) ex) Take the arguments at the method execution join point and output a set of arguments to the advice method.
private void	bindArgumentsByName(int numArgumentsExpectingToBind)
private void	bindExplicitArguments(int numArgumentsLeftToBind)
public final Pointcut	Returns: a composable pointcut that builds on the original AspectJ expression pointcut buildSafePointcut() Build a 'safe' pointcut that excludes the AspectJ advice method itself.
public final void	calculateArgumentBindings() Do as much work as we can as part of the set-up so that argument binding on subsequent advice invocations can be as fast as possible.
private void	configurePointcutParameters(String[] argumentNames, int argumentIndexOffset) All parameters from argumentIndexOffset onwards are candidates for pointcut parameters - but returning and throwing vars are handled differently and must be removed from the list if present.
protected ParameterNameDiscoverer	createParameterNameDiscoverer() Create a ParameterNameDiscoverer to be used for argument binding.
public static JoinPoint	Returns: current AspectJ joinpoint, or through an exception if we're not in a Spring AOP invocation. currentJoinPoint() Lazily instantiate joinpoint for the current invocation.
public final ClassLoader	getAspectClassLoader() Return the ClassLoader for aspect instances.
public final AspectInstanceFactory	getAspectInstanceFactory() Return the factory for aspect instances.
public final Method	getAspectJAdviceMethod() Return the AspectJ-style advice method.
public String	getAspectName() Implements org.springframework.aop.aspectj.AspectJPrecedenceInformation.getAspectName. Return the name of the aspect (bean) in which the advice was declared.
public int	getDeclarationOrder() Implements org.springframework.aop.aspectj.AspectJPrecedenceInformation.getDeclarationOrder. Return the declaration order of the advice member within the aspect.
protected Type	getDiscoveredReturningGenericType()
protected Class<?>	getDiscoveredReturningType()
protected Class<?>	getDiscoveredThrowingType()
protected JoinPoint	getJoinPoint() Overridden in around advice to return proceeding join point.
protected JoinPointMatch	getJoinPointMatch() Get the current join point match at the join point we are being dispatched on.
protected JoinPointMatch	getJoinPointMatch(ProxyMethodInvocation pmi)
public int	getOrder() Implements org.springframework.core.Ordered.getOrder. Get the order value of this object.
public final AspectJExpressionPointcut	getPointcut() Return the AspectJ expression pointcut.
protected Object	Returns: the invocation result invokeAdviceMethod(JoinPointMatch the JoinPointMatch that matched this execution join point jpMatch, Object the return value from the method execution (may be null) returnValue, Throwable the exception thrown by the method execution (may be null) ex) Invoke the advice method.
protected Object	invokeAdviceMethod(JoinPoint jp, JoinPointMatch jpMatch, Object returnValue, Throwable t)
protected Object	invokeAdviceMethodWithGivenArgs(Object[] args)
private static boolean	isVariableName(String name)
private boolean	maybeBindJoinPoint(Class<?> candidateParameterType)
private boolean	maybeBindJoinPointStaticPart(Class<?> candidateParameterType)
private boolean	maybeBindProceedingJoinPoint(Class<?> candidateParameterType)
private void	readObject(ObjectInputStream inputStream)
public void	setArgumentNames(String comma delimited list of argument names argumentNames) Set by the creator of this advice object if the argument names are known.
public void	setArgumentNamesFromStringArray(String... list of argument names argumentNames) Set by the creator of this advice object if the argument names are known.
public void	setAspectName(String name) Set the name of the aspect (bean) in which the advice was declared.
public void	setDeclarationOrder(int order) Set the declaration order of this advice within the aspect.
public void	setReturningName(String name)
protected void	setReturningNameNoCheck(String name) We need to hold the returning name at this level for argument binding calculations, this method allows the afterReturning advice subclass to set the name.
public void	setThrowingName(String name)
protected void	setThrowingNameNoCheck(String name) We need to hold the throwing name at this level for argument binding calculations, this method allows the afterThrowing advice subclass to set the name.
protected boolean	supportsProceedingJoinPoint()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

argumentBindings	back to summary
private Map<String, Integer> argumentBindings Annotations @Nullable

argumentNames	back to summary
private String[] argumentNames This will be non-null if the creator of this advice object knows the argument names and sets them explicitly. Annotations @Nullable

argumentsIntrospected	back to summary
private boolean argumentsIntrospected

aspectInstanceFactory	back to summary
private final AspectInstanceFactory aspectInstanceFactory

aspectJAdviceMethod	back to summary
protected transient Method aspectJAdviceMethod

aspectName	back to summary
private String aspectName The name of the aspect (ref bean) in which this advice was defined (used when determining advice precedence so that we can determine whether two pieces of advice come from the same aspect).

declarationOrder	back to summary
private int declarationOrder The order of declaration of this advice within the aspect.

declaringClass	back to summary
private final Class<?> declaringClass

discoveredReturningGenericType	back to summary
private Type discoveredReturningGenericType Annotations @Nullable

discoveredReturningType	back to summary
private Class<?> discoveredReturningType

discoveredThrowingType	back to summary
private Class<?> discoveredThrowingType

JOIN_POINT_KEY	back to summary
protected static final String JOIN_POINT_KEY Key used in ReflectiveMethodInvocation userAttributes map for the current joinpoint.

joinPointArgumentIndex	back to summary
private int joinPointArgumentIndex Index for thisJoinPoint argument (currently only supported at index 0 if present at all).

joinPointStaticPartArgumentIndex	back to summary
private int joinPointStaticPartArgumentIndex Index for thisJoinPointStaticPart argument (currently only supported at index 0 if present at all).

methodName	back to summary
private final String methodName

parameterTypes	back to summary
private final Class<?>[] parameterTypes

pointcut	back to summary
private final AspectJExpressionPointcut pointcut

returningName	back to summary
private String returningName Non-null if after returning advice binds the return value. Annotations @Nullable

throwingName	back to summary
private String throwingName Non-null if after throwing advice binds the thrown value. Annotations @Nullable

Constructor Detail

AbstractAspectJAdvice	back to summary
public AbstractAspectJAdvice(Method aspectJAdviceMethod, AspectJExpressionPointcut pointcut, AspectInstanceFactory aspectInstanceFactory) Create a new AbstractAspectJAdvice for the given advice method. Parameters aspectJAdviceMethod:Method the AspectJ-style advice method pointcut:AspectJExpressionPointcut the AspectJ expression pointcut aspectInstanceFactory:AspectInstanceFactory the factory for aspect instances

AbstractAspectJAdvice

back to summary

public AbstractAspectJAdvice(Method aspectJAdviceMethod, AspectJExpressionPointcut pointcut, AspectInstanceFactory aspectInstanceFactory)

Create a new AbstractAspectJAdvice for the given advice method.

Parameters

aspectJAdviceMethod:Method: the AspectJ-style advice method
pointcut:AspectJExpressionPointcut: the AspectJ expression pointcut
aspectInstanceFactory:AspectInstanceFactory: the factory for aspect instances

Method Detail

argBinding	back to summary
protected Object[] argBinding(JoinPoint jp, JoinPointMatch jpMatch, Object returnValue, Throwable ex) Take the arguments at the method execution join point and output a set of arguments to the advice method. Parameters jp:JoinPoint the current JoinPoint jpMatch:JoinPointMatch the join point match that matched this execution join point returnValue:Object the return value from the method execution (may be null) ex:Throwable the exception thrown by the method execution (may be null) Returns:Object[] the empty array if there are no arguments

argBinding

back to summary

protected Object[] argBinding(JoinPoint jp, JoinPointMatch jpMatch, Object returnValue, Throwable ex)

Take the arguments at the method execution join point and output a set of arguments to the advice method.

Parameters

jp:JoinPoint: the current JoinPoint
jpMatch:JoinPointMatch: the join point match that matched this execution join point
returnValue:Object: the return value from the method execution (may be null)
ex:Throwable: the exception thrown by the method execution (may be null)

Returns:Object[]

the empty array if there are no arguments

bindArgumentsByName	back to summary
private void bindArgumentsByName(int numArgumentsExpectingToBind)

bindExplicitArguments	back to summary
private void bindExplicitArguments(int numArgumentsLeftToBind)

buildSafePointcut back to summary

buildSafePointcut	back to summary
public final Pointcut buildSafePointcut() Build a 'safe' pointcut that excludes the AspectJ advice method itself. Returns:Pointcut a composable pointcut that builds on the original AspectJ expression pointcut See Also `getPointcut()`

public final Pointcut buildSafePointcut()

Build a 'safe' pointcut that excludes the AspectJ advice method itself.

Returns:Pointcut: a composable pointcut that builds on the original AspectJ expression pointcut
See Also: getPointcut()

calculateArgumentBindings back to summary

calculateArgumentBindings	back to summary
public final void calculateArgumentBindings() Do as much work as we can as part of the set-up so that argument binding on subsequent advice invocations can be as fast as possible. If the first argument is of type JoinPoint or ProceedingJoinPoint then we pass a JoinPoint in that position (ProceedingJoinPoint for around advice). If the first argument is of type `JoinPoint.StaticPart` then we pass a `JoinPoint.StaticPart` in that position. Remaining arguments have to be bound by pointcut evaluation at a given join point. We will get back a map from argument name to value. We need to calculate which advice parameter needs to be bound to which argument name. There are multiple strategies for determining this binding, which are arranged in a ChainOfResponsibility.

public final void calculateArgumentBindings()

Do as much work as we can as part of the set-up so that argument binding on subsequent advice invocations can be as fast as possible.

If the first argument is of type JoinPoint or ProceedingJoinPoint then we pass a JoinPoint in that position (ProceedingJoinPoint for around advice).

If the first argument is of type JoinPoint.StaticPart then we pass a JoinPoint.StaticPart in that position.

Remaining arguments have to be bound by pointcut evaluation at a given join point. We will get back a map from argument name to value. We need to calculate which advice parameter needs to be bound to which argument name. There are multiple strategies for determining this binding, which are arranged in a ChainOfResponsibility.

configurePointcutParameters	back to summary
private void configurePointcutParameters(String[] argumentNames, int argumentIndexOffset) All parameters from argumentIndexOffset onwards are candidates for pointcut parameters - but returning and throwing vars are handled differently and must be removed from the list if present.

createParameterNameDiscoverer back to summary

createParameterNameDiscoverer	back to summary
protected ParameterNameDiscoverer createParameterNameDiscoverer() Create a ParameterNameDiscoverer to be used for argument binding. The default implementation creates a `DefaultParameterNameDiscoverer` and adds a specifically configured `AspectJAdviceParameterNameDiscoverer`.

protected ParameterNameDiscoverer createParameterNameDiscoverer()

Create a ParameterNameDiscoverer to be used for argument binding.

The default implementation creates a DefaultParameterNameDiscoverer and adds a specifically configured AspectJAdviceParameterNameDiscoverer.

currentJoinPoint	back to summary
public static JoinPoint currentJoinPoint() Lazily instantiate joinpoint for the current invocation. Requires MethodInvocation to be bound with ExposeInvocationInterceptor. Do not use if access is available to the current ReflectiveMethodInvocation (in an around advice). Returns:JoinPoint current AspectJ joinpoint, or through an exception if we're not in a Spring AOP invocation.

currentJoinPoint

back to summary

public static JoinPoint currentJoinPoint()

Lazily instantiate joinpoint for the current invocation. Requires MethodInvocation to be bound with ExposeInvocationInterceptor.

Do not use if access is available to the current ReflectiveMethodInvocation (in an around advice).

Returns:JoinPoint: current AspectJ joinpoint, or through an exception if we're not in a Spring AOP invocation.

getAspectClassLoader	back to summary
public final ClassLoader getAspectClassLoader() Return the ClassLoader for aspect instances. Annotations @Nullable

getAspectClassLoader

back to summary

public final ClassLoader getAspectClassLoader()

Return the ClassLoader for aspect instances.

Annotations

@Nullable

getAspectInstanceFactory	back to summary
public final AspectInstanceFactory getAspectInstanceFactory() Return the factory for aspect instances.

getAspectJAdviceMethod	back to summary
public final Method getAspectJAdviceMethod() Return the AspectJ-style advice method.

getAspectName	back to summary
public String getAspectName() Implements org.springframework.aop.aspectj.AspectJPrecedenceInformation.getAspectName. Doc from org.springframework.aop.aspectj.AspectJPrecedenceInformation.getAspectName. Return the name of the aspect (bean) in which the advice was declared. Annotations @Override

getAspectName

back to summary

public String getAspectName()

Implements org.springframework.aop.aspectj.AspectJPrecedenceInformation.getAspectName.

Doc from org.springframework.aop.aspectj.AspectJPrecedenceInformation.getAspectName.

Return the name of the aspect (bean) in which the advice was declared.

Annotations

@Override

getDeclarationOrder	back to summary
public int getDeclarationOrder() Implements org.springframework.aop.aspectj.AspectJPrecedenceInformation.getDeclarationOrder. Doc from org.springframework.aop.aspectj.AspectJPrecedenceInformation.getDeclarationOrder. Return the declaration order of the advice member within the aspect. Annotations @Override

getDeclarationOrder

back to summary

public int getDeclarationOrder()

Implements org.springframework.aop.aspectj.AspectJPrecedenceInformation.getDeclarationOrder.

Doc from org.springframework.aop.aspectj.AspectJPrecedenceInformation.getDeclarationOrder.

Return the declaration order of the advice member within the aspect.

Annotations

@Override

getDiscoveredReturningGenericType	back to summary
protected Type getDiscoveredReturningGenericType() Annotations @Nullable

getDiscoveredReturningType	back to summary
protected Class<?> getDiscoveredReturningType()

getDiscoveredThrowingType	back to summary
protected Class<?> getDiscoveredThrowingType()

getJoinPoint	back to summary
protected JoinPoint getJoinPoint() Overridden in around advice to return proceeding join point.

getJoinPointMatch	back to summary
protected JoinPointMatch getJoinPointMatch() Get the current join point match at the join point we are being dispatched on. Annotations @Nullable

getJoinPointMatch

back to summary

protected JoinPointMatch getJoinPointMatch()

Get the current join point match at the join point we are being dispatched on.

Annotations

@Nullable

getJoinPointMatch	back to summary
protected JoinPointMatch getJoinPointMatch(ProxyMethodInvocation pmi) Annotations @Nullable

getOrder back to summary

getOrder	back to summary
public int getOrder() Implements org.springframework.core.Ordered.getOrder. Doc from org.springframework.core.Ordered.getOrder. Get the order value of this object. Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet `load-on-startup` values). Same order values will result in arbitrary sort positions for the affected objects. Returns:int the order value Annotations @Override

public int getOrder()

Implements org.springframework.core.Ordered.getOrder.

Doc from org.springframework.core.Ordered.getOrder.

Get the order value of this object.

Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet load-on-startup values).

Same order values will result in arbitrary sort positions for the affected objects.

Returns:int

the order value

Annotations

@Override

getPointcut	back to summary
public final AspectJExpressionPointcut getPointcut() Return the AspectJ expression pointcut.

invokeAdviceMethod	back to summary
protected Object invokeAdviceMethod(JoinPointMatch jpMatch, Object returnValue, Throwable ex) throws Throwable Invoke the advice method. Parameters jpMatch:JoinPointMatch the JoinPointMatch that matched this execution join point returnValue:Object the return value from the method execution (may be null) ex:Throwable the exception thrown by the method execution (may be null) Returns:Object the invocation result Exceptions Throwable: in case of invocation failure

invokeAdviceMethod

back to summary

protected Object invokeAdviceMethod(JoinPointMatch jpMatch, Object returnValue, Throwable ex) throws Throwable

Invoke the advice method.

Parameters

jpMatch:JoinPointMatch: the JoinPointMatch that matched this execution join point
returnValue:Object: the return value from the method execution (may be null)
ex:Throwable: the exception thrown by the method execution (may be null)

Returns:Object

the invocation result

Exceptions

Throwable:: in case of invocation failure

invokeAdviceMethod	back to summary
protected Object invokeAdviceMethod(JoinPoint jp, JoinPointMatch jpMatch, Object returnValue, Throwable t) throws Throwable

invokeAdviceMethodWithGivenArgs	back to summary
protected Object invokeAdviceMethodWithGivenArgs(Object[] args) throws Throwable

isVariableName	back to summary
private static boolean isVariableName(String name)

maybeBindJoinPoint	back to summary
private boolean maybeBindJoinPoint(Class<?> candidateParameterType)

maybeBindJoinPointStaticPart	back to summary
private boolean maybeBindJoinPointStaticPart(Class<?> candidateParameterType)

maybeBindProceedingJoinPoint	back to summary
private boolean maybeBindProceedingJoinPoint(Class<?> candidateParameterType)

readObject	back to summary
private void readObject(ObjectInputStream inputStream) throws IOException, ClassNotFoundException

setArgumentNames

back to summary

public void setArgumentNames(String argumentNames)

Set by the creator of this advice object if the argument names are known.

This could be for example because they have been explicitly specified in XML or in an advice annotation.

Parameters

argumentNames:String: comma delimited list of argument names

setArgumentNamesFromStringArray

back to summary

public void setArgumentNamesFromStringArray(String... argumentNames)

Set by the creator of this advice object if the argument names are known.

This could be for example because they have been explicitly specified in XML or in an advice annotation.

Parameters

argumentNames:String[]: list of argument names

setAspectName	back to summary
public void setAspectName(String name) Set the name of the aspect (bean) in which the advice was declared.

setDeclarationOrder	back to summary
public void setDeclarationOrder(int order) Set the declaration order of this advice within the aspect.

setReturningName	back to summary
public void setReturningName(String name)

setReturningNameNoCheck	back to summary
protected void setReturningNameNoCheck(String name) We need to hold the returning name at this level for argument binding calculations, this method allows the afterReturning advice subclass to set the name.

setThrowingName	back to summary
public void setThrowingName(String name)

setThrowingNameNoCheck	back to summary
protected void setThrowingNameNoCheck(String name) We need to hold the throwing name at this level for argument binding calculations, this method allows the afterThrowing advice subclass to set the name.

supportsProceedingJoinPoint	back to summary
protected boolean supportsProceedingJoinPoint()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.springframework.aop.aspectj back to summary

private Class AbstractAspectJAdvice.AdviceExcludingMethodMatcher

Class Inheritance

extends StaticMethodMatcher

java.lang.Object
org.springframework.aop.support.StaticMethodMatcher
org.springframework.aop.aspectj.AbstractAspectJAdvice.AdviceExcludingMethodMatcher

MethodMatcher that excludes the specified advice method.

See Also: AbstractAspectJAdvice#buildSafePointcut()

Field Summary

Modifier and Type	Field and Description
private final Method	adviceMethod

Constructor Summary

Access	Constructor and Description
public	AdviceExcludingMethodMatcher(Method adviceMethod)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	matches(Method the candidate method method, Class<?> the target class targetClass) Implements org.springframework.aop.MethodMatcher.matches. Perform static checking to determine whether the given method matches.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from org.springframework.aop.support.StaticMethodMatcher:: isRuntime matches

Field Detail

adviceMethod	back to summary
private final Method adviceMethod

Constructor Detail

AdviceExcludingMethodMatcher	back to summary
public AdviceExcludingMethodMatcher(Method adviceMethod)

Method Detail

equals back to summary

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations