Top Description Fields Constructors Methods
org.springframework.transaction.annotation

public Class AnnotationTransactionAttributeSource

extends AbstractFallbackTransactionAttributeSource
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Annotations
@SuppressWarnings:serial
Imports
java.io.Serializable, java.lang.reflect.AnnotatedElement, .Method, java.util.Arrays, .Collections, .LinkedHashSet, .Set, org.springframework.lang.Nullable, org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource, .TransactionAttribute, org.springframework.util.Assert, .ClassUtils
Implementation of the org.springframework.transaction.interceptor.TransactionAttributeSource interface for working with transaction metadata in JDK 1.5+ annotation format.

This class reads Spring's JDK 1.5+ Transactional annotation and exposes corresponding transaction attributes to Spring's transaction infrastructure. Also supports JTA 1.2's jakarta.transaction.Transactional and EJB3's jakarta.ejb.TransactionAttribute annotation (if present). This class may also serve as base class for a custom TransactionAttributeSource, or get customized through TransactionAnnotationParser strategies.

Authors
Colin Sampaleanu, Juergen Hoeller
Since
1.2
See Also
Transactional, TransactionAnnotationParser, SpringTransactionAnnotationParser, Ejb3TransactionAnnotationParser, org.springframework.transaction.interceptor.TransactionInterceptor#setTransactionAttributeSource, org.springframework.transaction.interceptor.TransactionProxyFactoryBean#setTransactionAttributeSource

Field Summary

Modifier and TypeField and Description
private final Set<TransactionAnnotationParser>
annotationParsers

private static final boolean
ejb3Present

private static final boolean
jta12Present

private final boolean
publicMethodsOnly

Inherited from org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource:
logger

Constructor Summary

AccessConstructor and Description
public
AnnotationTransactionAttributeSource()

Create a default AnnotationTransactionAttributeSource, supporting public methods that carry the Transactional annotation or the EJB3 jakarta.ejb.TransactionAttribute annotation.

public
AnnotationTransactionAttributeSource(boolean
whether to support public methods that carry the Transactional annotation only (typically for use with proxy-based AOP), or protected/private methods as well (typically used with AspectJ class weaving)
publicMethodsOnly)

Create a custom AnnotationTransactionAttributeSource, supporting public methods that carry the Transactional annotation or the EJB3 jakarta.ejb.TransactionAttribute annotation.

public
AnnotationTransactionAttributeSource(TransactionAnnotationParser
the TransactionAnnotationParser to use
annotationParser)

Create a custom AnnotationTransactionAttributeSource.

public
AnnotationTransactionAttributeSource(TransactionAnnotationParser...
the TransactionAnnotationParsers to use
annotationParsers)

Create a custom AnnotationTransactionAttributeSource.

public
AnnotationTransactionAttributeSource(Set<TransactionAnnotationParser>
the TransactionAnnotationParsers to use
annotationParsers)

Create a custom AnnotationTransactionAttributeSource.

Method Summary

Modifier and TypeMethod and Description
protected boolean
allowPublicMethodsOnly()

Overrides org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource.allowPublicMethodsOnly.

By default, only public methods can be made transactional.

protected TransactionAttribute

Returns:

the configured transaction attribute, or null if none was found
determineTransactionAttribute(AnnotatedElement
the annotated method or class
element)

Determine the transaction attribute for the given method or class.

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.

protected TransactionAttribute
findTransactionAttribute(Class<?>
the class to retrieve the attribute for
clazz)

Implements abstract org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource.findTransactionAttribute.

Subclasses need to implement this to return the transaction attribute for the given class, if any.

protected TransactionAttribute
findTransactionAttribute(Method
the method to retrieve the attribute for
method)

Implements abstract org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource.findTransactionAttribute.

Subclasses need to implement this to return the transaction attribute for the given method, if any.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isCandidateClass(Class<?>
the class to introspect
targetClass)

Overrides default org.springframework.transaction.interceptor.TransactionAttributeSource.isCandidateClass.

Determine whether the given class is a candidate for transaction attributes in the metadata format of this TransactionAttributeSource.

Inherited from org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource:
computeTransactionAttributegetCacheKeygetTransactionAttributesetEmbeddedValueResolver

Field Detail

annotationParsersback to summary
private final Set<TransactionAnnotationParser> annotationParsers
ejb3Presentback to summary
private static final boolean ejb3Present
jta12Presentback to summary
private static final boolean jta12Present
publicMethodsOnlyback to summary
private final boolean publicMethodsOnly

Constructor Detail

AnnotationTransactionAttributeSourceback to summary
public AnnotationTransactionAttributeSource()

Create a default AnnotationTransactionAttributeSource, supporting public methods that carry the Transactional annotation or the EJB3 jakarta.ejb.TransactionAttribute annotation.

AnnotationTransactionAttributeSourceback to summary
public AnnotationTransactionAttributeSource(boolean publicMethodsOnly)

Create a custom AnnotationTransactionAttributeSource, supporting public methods that carry the Transactional annotation or the EJB3 jakarta.ejb.TransactionAttribute annotation.

Parameters
publicMethodsOnly:boolean

whether to support public methods that carry the Transactional annotation only (typically for use with proxy-based AOP), or protected/private methods as well (typically used with AspectJ class weaving)

AnnotationTransactionAttributeSourceback to summary
public AnnotationTransactionAttributeSource(TransactionAnnotationParser annotationParser)

Create a custom AnnotationTransactionAttributeSource.

Parameters
annotationParser:TransactionAnnotationParser

the TransactionAnnotationParser to use

AnnotationTransactionAttributeSourceback to summary
public AnnotationTransactionAttributeSource(TransactionAnnotationParser... annotationParsers)

Create a custom AnnotationTransactionAttributeSource.

Parameters
annotationParsers:TransactionAnnotationParser[]

the TransactionAnnotationParsers to use

AnnotationTransactionAttributeSourceback to summary
public AnnotationTransactionAttributeSource(Set<TransactionAnnotationParser> annotationParsers)

Create a custom AnnotationTransactionAttributeSource.

Parameters
annotationParsers:Set<TransactionAnnotationParser>

the TransactionAnnotationParsers to use

Method Detail

allowPublicMethodsOnlyback to summary
protected boolean allowPublicMethodsOnly()

Overrides org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource.allowPublicMethodsOnly.

By default, only public methods can be made transactional.

Annotations
@Override
determineTransactionAttributeback to summary
protected TransactionAttribute determineTransactionAttribute(AnnotatedElement element)

Determine the transaction attribute for the given method or class.

This implementation delegates to configured TransactionAnnotationParsers for parsing known annotations into Spring's metadata attribute class. Returns null if it's not transactional.

Can be overridden to support custom annotations that carry transaction metadata.

Parameters
element:AnnotatedElement

the annotated method or class

Returns:TransactionAttribute

the configured transaction attribute, or null if none was found

Annotations
@Nullable
equalsback 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
findTransactionAttributeback to summary
protected TransactionAttribute findTransactionAttribute(Class<?> clazz)

Implements abstract org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource.findTransactionAttribute.

Doc from org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource.findTransactionAttribute.

Subclasses need to implement this to return the transaction attribute for the given class, if any.

Parameters
clazz:Class<?>

the class to retrieve the attribute for

Returns:TransactionAttribute

all transaction attribute associated with this class, or null if none

Annotations
@Override
@Nullable
findTransactionAttributeback to summary
protected TransactionAttribute findTransactionAttribute(Method method)

Implements abstract org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource.findTransactionAttribute.

Doc from org.springframework.transaction.interceptor.AbstractFallbackTransactionAttributeSource.findTransactionAttribute.

Subclasses need to implement this to return the transaction attribute for the given method, if any.

Parameters
method:Method

the method to retrieve the attribute for

Returns:TransactionAttribute

all transaction attribute associated with this method, or null if none

Annotations
@Override
@Nullable
hashCodeback 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
@Override
isCandidateClassback to summary
public boolean isCandidateClass(Class<?> targetClass)

Overrides default org.springframework.transaction.interceptor.TransactionAttributeSource.isCandidateClass.

Doc from org.springframework.transaction.interceptor.TransactionAttributeSource.isCandidateClass.

Determine whether the given class is a candidate for transaction attributes in the metadata format of this TransactionAttributeSource.

If this method returns false, the methods on the given class will not get traversed for getTransactionAttribute introspection. Returning false is therefore an optimization for non-affected classes, whereas true simply means that the class needs to get fully introspected for each method on the given class individually.

Parameters
targetClass:Class<?>

the class to introspect

Returns:boolean

false if the class is known to have no transaction attributes at class or method level; true otherwise. The default implementation returns true, leading to regular introspection.

Annotations
@Override