org.springframework.aop.aspectj.annotation

Class AbstractAspectJAdvisorFactory

java.lang.Object

org.springframework.aop.aspectj.annotation.AbstractAspectJAdvisorFactory

All Implemented Interfaces:

AspectJAdvisorFactory

Direct Known Subclasses:

ReflectiveAspectJAdvisorFactory

public abstract class AbstractAspectJAdvisorFactory
extends java.lang.Object
implements AspectJAdvisorFactory

Abstract base class for factories that can create Spring AOP Advisors given AspectJ classes from classes honoring the AspectJ 5 annotation syntax.

This class handles annotation parsing and validation functionality. It does not actually generate Spring AOP Advisors, which is deferred to subclasses.

Since:

2.0

Author:

Rod Johnson, Adrian Colyer, Juergen Hoeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractAspectJAdvisorFactory.AspectJAnnotation<A extends java.lang.annotation.Annotation> Class modelling an AspectJ annotation, exposing its type enumeration and pointcut String.
private static class	AbstractAspectJAdvisorFactory.AspectJAnnotationParameterNameDiscoverer ParameterNameDiscoverer implementation that analyzes the arg names specified at the AspectJ annotation level.
protected static class	AbstractAspectJAdvisorFactory.AspectJAnnotationType

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	AJC_MAGIC
protected Log	logger Logger available to subclasses
protected ParameterNameDiscoverer	parameterNameDiscoverer

Constructor Summary

Constructors

Constructor and Description
AbstractAspectJAdvisorFactory()

Method Summary

Modifier and Type	Method and Description
private boolean	compiledByAjc(java.lang.Class<?> clazz) We need to detect this as "code-style" AspectJ aspects should not be interpreted by Spring AOP.
protected AspectJExpressionPointcut	createPointcutExpression(java.lang.reflect.Method annotatedMethod, java.lang.Class<?> declarationScope, java.lang.String[] pointcutParameterNames) The pointcut and advice annotations both have an "argNames" member which contains a comma-separated list of the argument names.
private java.lang.Class<?>[]	extractPointcutParameterTypes(java.lang.String[] argNames, java.lang.reflect.Method adviceMethod) Create the pointcut parameters needed by aspectj based on the given argument names and the argument types that are available from the adviceMethod.
private static <A extends java.lang.annotation.Annotation> AbstractAspectJAdvisorFactory.AspectJAnnotation<A>	findAnnotation(java.lang.reflect.Method method, java.lang.Class<A> toLookFor)
protected static AbstractAspectJAdvisorFactory.AspectJAnnotation<?>	findAspectJAnnotationOnMethod(java.lang.reflect.Method method) Find and return the first AspectJ annotation on the given method (there should only be one anyway...)
private boolean	hasAspectAnnotation(java.lang.Class<?> clazz)
boolean	isAspect(java.lang.Class<?> clazz) We consider something to be an AspectJ aspect suitable for use by the Spring AOP system if it has the @Aspect annotation, and was not compiled by ajc.
void	validate(java.lang.Class<?> aspectClass) Is the given class a valid AspectJ aspect class?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory

getAdvice, getAdvisor, getAdvisors

Field Detail

AJC_MAGIC

private static final java.lang.String AJC_MAGIC

See Also:

Constant Field Values

logger

protected final Log logger

Logger available to subclasses

parameterNameDiscoverer

protected final ParameterNameDiscoverer parameterNameDiscoverer

Constructor Detail

AbstractAspectJAdvisorFactory

public AbstractAspectJAdvisorFactory()

Method Detail

findAspectJAnnotationOnMethod

protected static AbstractAspectJAdvisorFactory.AspectJAnnotation<?> findAspectJAnnotationOnMethod(java.lang.reflect.Method method)

Find and return the first AspectJ annotation on the given method (there should only be one anyway...)

findAnnotation

private static <A extends java.lang.annotation.Annotation> AbstractAspectJAdvisorFactory.AspectJAnnotation<A> findAnnotation(java.lang.reflect.Method method,
                                                                                                                             java.lang.Class<A> toLookFor)

isAspect

public boolean isAspect(java.lang.Class<?> clazz)

We consider something to be an AspectJ aspect suitable for use by the Spring AOP system if it has the @Aspect annotation, and was not compiled by ajc. The reason for this latter test is that aspects written in the code-style (AspectJ language) also have the annotation present when compiled by ajc with the -1.5 flag, yet they cannot be consumed by Spring AOP.

Specified by:

isAspect in interface AspectJAdvisorFactory

Parameters:

clazz - the supposed annotation-style AspectJ class

Returns:

whether or not this class is recognized by AspectJ as an aspect class

hasAspectAnnotation

private boolean hasAspectAnnotation(java.lang.Class<?> clazz)

compiledByAjc

private boolean compiledByAjc(java.lang.Class<?> clazz)

We need to detect this as "code-style" AspectJ aspects should not be interpreted by Spring AOP.

validate

public void validate(java.lang.Class<?> aspectClass)
              throws AopConfigException

Description copied from interface: AspectJAdvisorFactory

Is the given class a valid AspectJ aspect class?

Specified by:

validate in interface AspectJAdvisorFactory

Parameters:

aspectClass - the supposed AspectJ annotation-style class to validate

Throws:

AopConfigException - if the class is an invalid aspect (which can never be legal)

NotAnAtAspectException - if the class is not an aspect at all (which may or may not be legal, depending on the context)

createPointcutExpression

protected AspectJExpressionPointcut createPointcutExpression(java.lang.reflect.Method annotatedMethod,
                                                             java.lang.Class<?> declarationScope,
                                                             java.lang.String[] pointcutParameterNames)

The pointcut and advice annotations both have an "argNames" member which contains a comma-separated list of the argument names. We use this (if non-empty) to build the formal parameters for the pointcut.

extractPointcutParameterTypes

private java.lang.Class<?>[] extractPointcutParameterTypes(java.lang.String[] argNames,
                                                           java.lang.reflect.Method adviceMethod)

Create the pointcut parameters needed by aspectj based on the given argument names and the argument types that are available from the adviceMethod. Needs to take into account (ignore) any JoinPoint based arguments as these are not pointcut context but rather part of the advice execution context (thisJoinPoint, thisJoinPointStaticPart)