Top Description Inners Fields Constructors Methods

org.springframework.aop.aspectj.annotation

public abstract Class AbstractAspectJAdvisorFactory

Class Inheritance

extends Object
implements AspectJAdvisorFactory

java.lang.Object
org.springframework.aop.aspectj.annotation.AbstractAspectJAdvisorFactory

All Implemented Interfaces

org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory

Known Direct Subclasses

org.springframework.aop.aspectj.annotation.ReflectiveAspectJAdvisorFactory

Imports

java.lang.annotation.Annotation, java.lang.reflect.Constructor, .Field, .Method, java.util.Map, .StringTokenizer, org.apache.commons.logging.Log, .LogFactory, org.aspectj.lang.annotation.After, .AfterReturning, .AfterThrowing, .Around, .Aspect, .Before, .Pointcut, org.aspectj.lang.reflect.AjType, .AjTypeSystem, .PerClauseKind, org.springframework.aop.framework.AopConfigException, org.springframework.core.ParameterNameDiscoverer, org.springframework.core.annotation.AnnotationUtils, org.springframework.lang.Nullable

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.

Authors: Rod Johnson, Adrian Colyer, Juergen Hoeller, Sam Brannen
Since: 2.0

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected static class	AbstractAspectJAdvisorFactory.AspectJAnnotation Class modeling 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 enum	AbstractAspectJAdvisorFactory.AspectJAnnotationType Enum for AspectJ annotation types.

Field Summary

Modifier and Type	Field and Description
private static final String	AJC_MAGIC
private static final Class<?>[]	ASPECTJ_ANNOTATION_CLASSES
protected final Log	logger Logger available to subclasses.
protected final ParameterNameDiscoverer	parameterNameDiscoverer

Constructor Summary

Access	Constructor and Description
public	AbstractAspectJAdvisorFactory()

Method Summary

Modifier and Type	Method and Description
pack-priv static boolean	compiledByAjc(Class<?> clazz) We need to detect this as "code-style" AspectJ aspects should not be interpreted by Spring AOP.
private static AbstractAspectJAdvisorFactory.AspectJAnnotation	findAnnotation(Method method, Class<? extends Annotation> annotationType)
protected static AbstractAspectJAdvisorFactory.AspectJAnnotation	findAspectJAnnotationOnMethod(Method method) Find and return the first AspectJ annotation on the given method (there should only be one anyway...).
private boolean	hasAspectAnnotation(Class<?> clazz)
public boolean	isAspect(Class<?> the supposed annotation-style AspectJ class clazz) Implements org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.isAspect. 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.
public void	validate(Class<?> the supposed AspectJ annotation-style class to validate aspectClass) Implements org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.validate. Is the given class a valid AspectJ aspect class?

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

Field Detail

AJC_MAGIC	back to summary
private static final String AJC_MAGIC

ASPECTJ_ANNOTATION_CLASSES	back to summary
private static final Class<?>[] ASPECTJ_ANNOTATION_CLASSES

logger	back to summary
protected final Log logger Logger available to subclasses.

parameterNameDiscoverer	back to summary
protected final ParameterNameDiscoverer parameterNameDiscoverer

Constructor Detail

AbstractAspectJAdvisorFactory	back to summary
public AbstractAspectJAdvisorFactory()

Method Detail

compiledByAjc	back to summary
pack-priv static boolean compiledByAjc(Class<?> clazz) We need to detect this as "code-style" AspectJ aspects should not be interpreted by Spring AOP.

findAnnotation	back to summary
private static AbstractAspectJAdvisorFactory.AspectJAnnotation findAnnotation(Method method, Class<? extends Annotation> annotationType) Annotations @Nullable

findAspectJAnnotationOnMethod	back to summary
protected static AbstractAspectJAdvisorFactory.AspectJAnnotation findAspectJAnnotationOnMethod(Method method) Find and return the first AspectJ annotation on the given method (there should only be one anyway...). Annotations @SuppressWarnings:unchecked @Nullable

findAspectJAnnotationOnMethod

back to summary

protected static AbstractAspectJAdvisorFactory.AspectJAnnotation findAspectJAnnotationOnMethod(Method method)

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

Annotations

@SuppressWarnings:unchecked
@Nullable

hasAspectAnnotation	back to summary
private boolean hasAspectAnnotation(Class<?> clazz)

isAspect	back to summary
public boolean isAspect(Class<?> clazz) Implements org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.isAspect. 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. Parameters clazz:Class<?> Doc from org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.isAspect. the supposed annotation-style AspectJ class Returns:boolean Doc from org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.isAspect. whether this class is recognized by AspectJ as an aspect class Annotations @Override

isAspect

back to summary

public boolean isAspect(Class<?> clazz)

Implements org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.isAspect.

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.

Parameters

clazz:Class<?>

Doc from org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.isAspect.

the supposed annotation-style AspectJ class

Returns:boolean

Doc from org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.isAspect.

whether this class is recognized by AspectJ as an aspect class

Annotations

@Override

validate	back to summary
public void validate(Class<?> aspectClass) throws AopConfigException Implements org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.validate. Doc from org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.validate. Is the given class a valid AspectJ aspect class? Parameters aspectClass:Class<?> the supposed AspectJ annotation-style class to validate Annotations @Override Exceptions AopConfigException: if the class is an invalid aspect (which can never be legal)

validate

back to summary

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

Implements org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.validate.

Doc from org.springframework.aop.aspectj.annotation.AspectJAdvisorFactory.validate.

Is the given class a valid AspectJ aspect class?

Parameters

aspectClass:Class<?>: the supposed AspectJ annotation-style class to validate

Annotations

@Override

Exceptions

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

org.springframework.aop.aspectj.annotation back to summary

protected Class AbstractAspectJAdvisorFactory.AspectJAnnotation

Class Inheritance

extends Object

java.lang.Object
org.springframework.aop.aspectj.annotation.AbstractAspectJAdvisorFactory.AspectJAnnotation

Class modeling an AspectJ annotation, exposing its type enumeration and pointcut String.

Field Summary

Modifier and Type	Field and Description
private final Annotation	annotation
private final AbstractAspectJAdvisorFactory.AspectJAnnotationType	annotationType
private static final Map<Class<?>, AbstractAspectJAdvisorFactory.AspectJAnnotationType>	annotationTypeMap
private final String	argumentNames
private static final String[]	EXPRESSION_ATTRIBUTES
private final String	pointcutExpression

Constructor Summary

Access	Constructor and Description
public	AspectJAnnotation(Annotation annotation)

Method Summary

Modifier and Type	Method and Description
private AbstractAspectJAdvisorFactory.AspectJAnnotationType	determineAnnotationType(Annotation annotation)
public Annotation	getAnnotation()
public AbstractAspectJAdvisorFactory.AspectJAnnotationType	getAnnotationType()
public String	getArgumentNames()
public String	getPointcutExpression()
private String	resolvePointcutExpression(Annotation annotation)
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

annotation	back to summary
private final Annotation annotation

annotationType	back to summary
private final AbstractAspectJAdvisorFactory.AspectJAnnotationType annotationType

annotationTypeMap	back to summary
private static final Map<Class<?>, AbstractAspectJAdvisorFactory.AspectJAnnotationType> annotationTypeMap

argumentNames	back to summary
private final String argumentNames

EXPRESSION_ATTRIBUTES	back to summary
private static final String[] EXPRESSION_ATTRIBUTES

pointcutExpression	back to summary
private final String pointcutExpression

Constructor Detail

AspectJAnnotation	back to summary
public AspectJAnnotation(Annotation annotation)

Method Detail

determineAnnotationType	back to summary
private AbstractAspectJAdvisorFactory.AspectJAnnotationType determineAnnotationType(Annotation annotation)

getAnnotation	back to summary
public Annotation getAnnotation()

getAnnotationType	back to summary
public AbstractAspectJAdvisorFactory.AspectJAnnotationType getAnnotationType()

getArgumentNames	back to summary
public String getArgumentNames()

getPointcutExpression	back to summary
public String getPointcutExpression()

resolvePointcutExpression	back to summary
private String resolvePointcutExpression(Annotation annotation)

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. Returns:String a string representation of the object. Annotations @Override

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.

Returns:String

a string representation of the object.

Annotations

@Override

org.springframework.aop.aspectj.annotation back to summary

private Class AbstractAspectJAdvisorFactory.AspectJAnnotationParameterNameDiscoverer

Class Inheritance

extends Object
implements ParameterNameDiscoverer

java.lang.Object
org.springframework.aop.aspectj.annotation.AbstractAspectJAdvisorFactory.AspectJAnnotationParameterNameDiscoverer

All Implemented Interfaces

org.springframework.core.ParameterNameDiscoverer

ParameterNameDiscoverer implementation that analyzes the arg names specified at the AspectJ annotation level.

Field Summary

Modifier and Type	Field and Description
private static final String[]	EMPTY_ARRAY

Constructor Summary

Access	Constructor and Description
private	AspectJAnnotationParameterNameDiscoverer()

Method Summary

Modifier and Type	Method and Description
public String[]	getParameterNames(Method the method to find parameter names for method) Implements org.springframework.core.ParameterNameDiscoverer.getParameterNames. Return parameter names for a method, or `null` if they cannot be determined.
public String[]	getParameterNames(Constructor<?> the constructor to find parameter names for ctor) Implements org.springframework.core.ParameterNameDiscoverer.getParameterNames. Return parameter names for a constructor, or `null` if they cannot be determined.

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

Field Detail

EMPTY_ARRAY	back to summary
private static final String[] EMPTY_ARRAY

Constructor Detail

AspectJAnnotationParameterNameDiscoverer	back to summary
private AspectJAnnotationParameterNameDiscoverer()

Method Detail

getParameterNames back to summary

getParameterNames	back to summary
public String[] getParameterNames(Method method) Implements org.springframework.core.ParameterNameDiscoverer.getParameterNames. Doc from org.springframework.core.ParameterNameDiscoverer.getParameterNames. Return parameter names for a method, or `null` if they cannot be determined. Individual entries in the array may be `null` if parameter names are only available for some parameters of the given method but not for others. However, it is recommended to use stub parameter names instead wherever feasible. Parameters method:Method the method to find parameter names for Returns:String[] an array of parameter names if the names can be resolved, or `null` if they cannot Annotations @Override @Nullable

public String[] getParameterNames(Method method)

Implements org.springframework.core.ParameterNameDiscoverer.getParameterNames.

Doc from org.springframework.core.ParameterNameDiscoverer.getParameterNames.

Return parameter names for a method, or null if they cannot be determined.

Individual entries in the array may be null if parameter names are only available for some parameters of the given method but not for others. However, it is recommended to use stub parameter names instead wherever feasible.

Parameters

method:Method: the method to find parameter names for

Returns:String[]

an array of parameter names if the names can be resolved, or null if they cannot

Annotations

@Override
@Nullable

getParameterNames back to summary

getParameterNames	back to summary
public String[] getParameterNames(Constructor<?> ctor) Implements org.springframework.core.ParameterNameDiscoverer.getParameterNames. Doc from org.springframework.core.ParameterNameDiscoverer.getParameterNames. Return parameter names for a constructor, or `null` if they cannot be determined. Individual entries in the array may be `null` if parameter names are only available for some parameters of the given constructor but not for others. However, it is recommended to use stub parameter names instead wherever feasible. Parameters ctor:Constructor<?> the constructor to find parameter names for Returns:String[] an array of parameter names if the names can be resolved, or `null` if they cannot Annotations @Override @Nullable

public String[] getParameterNames(Constructor<?> ctor)

Implements org.springframework.core.ParameterNameDiscoverer.getParameterNames.

Doc from org.springframework.core.ParameterNameDiscoverer.getParameterNames.

Return parameter names for a constructor, or null if they cannot be determined.

Individual entries in the array may be null if parameter names are only available for some parameters of the given constructor but not for others. However, it is recommended to use stub parameter names instead wherever feasible.

Parameters

ctor:Constructor<?>: the constructor to find parameter names for

Returns:String[]

an array of parameter names if the names can be resolved, or null if they cannot

Annotations

@Override
@Nullable

org.springframework.aop.aspectj.annotation back to summary

protected final Enum AbstractAspectJAdvisorFactory.AspectJAnnotationType

Class Inheritance

extends Enum<AbstractAspectJAdvisorFactory.AspectJAnnotationType>

java.lang.Object
java.lang.Enum
org.springframework.aop.aspectj.annotation.AbstractAspectJAdvisorFactory.AspectJAnnotationType

Enum for AspectJ annotation types.

See Also: AspectJAnnotation#getAnnotationType()

Field Summary

Modifier and Type	Field and Description
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType	AtAfter
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType	AtAfterReturning
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType	AtAfterThrowing
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType	AtAround
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType	AtBefore
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType	AtPointcut

Constructor Summary

Access	Constructor and Description
private	AspectJAnnotationType()

Method Summary

Modifier and Type	Method and Description
public static AbstractAspectJAdvisorFactory.AspectJAnnotationType	valueOf(String name)
public static AbstractAspectJAdvisorFactory.AspectJAnnotationType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

AtAfter	back to summary
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType AtAfter

AtAfterReturning	back to summary
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType AtAfterReturning

AtAfterThrowing	back to summary
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType AtAfterThrowing

AtAround	back to summary
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType AtAround

AtBefore	back to summary
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType AtBefore

AtPointcut	back to summary
public static final AbstractAspectJAdvisorFactory.AspectJAnnotationType AtPointcut

Constructor Detail

AspectJAnnotationType	back to summary
private AspectJAnnotationType()

Method Detail

valueOf	back to summary
public static AbstractAspectJAdvisorFactory.AspectJAnnotationType valueOf(String name)

values	back to summary
public static AbstractAspectJAdvisorFactory.AspectJAnnotationType[] values()