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

public Class Ejb3TransactionAnnotationParser

extends Object
implements TransactionAnnotationParser, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.springframework.transaction.annotation.TransactionAnnotationParser
Annotations
@SuppressWarnings:serial
Imports
java.io.Serializable, java.lang.reflect.AnnotatedElement, jakarta.ejb.ApplicationException, .TransactionAttributeType, org.springframework.core.annotation.AnnotationUtils, org.springframework.lang.Nullable, org.springframework.transaction.interceptor.DefaultTransactionAttribute, .TransactionAttribute

Strategy implementation for parsing EJB3's jakarta.ejb.TransactionAttribute annotation.
Author
Juergen Hoeller
Since
2.5

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
Ejb3TransactionAnnotationParser.Ejb3TransactionAttribute

EJB3-specific TransactionAttribute, implementing EJB3's rollback rules which are based on annotated exceptions.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod 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 the object.
public boolean
isCandidateClass(Class<?>
the class to introspect
targetClass
)

Overrides default org.springframework.transaction.annotation.TransactionAnnotationParser.isCandidateClass.

Determine whether the given class is a candidate for transaction attributes in the annotation format of this TransactionAnnotationParser.
public TransactionAttribute
parseTransactionAnnotation(AnnotatedElement
the annotated method or class
element
)

Implements org.springframework.transaction.annotation.TransactionAnnotationParser.parseTransactionAnnotation.

Parse the transaction attribute for the given method or class, based on an annotation type understood by this parser.
public TransactionAttribute
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Ejb3TransactionAnnotationParserback to summary
public Ejb3TransactionAnnotationParser()

Method Detail

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
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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.annotation.TransactionAnnotationParser.isCandidateClass.

Doc from org.springframework.transaction.annotation.TransactionAnnotationParser.isCandidateClass.

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

If this method returns false, the methods on the given class will not get traversed for #parseTransactionAnnotation 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 annotations at class or method level; true otherwise. The default implementation returns true, leading to regular introspection.

Annotations
@Override
parseTransactionAnnotationback to summary
public TransactionAttribute parseTransactionAnnotation(AnnotatedElement element)

Implements org.springframework.transaction.annotation.TransactionAnnotationParser.parseTransactionAnnotation.

Doc from org.springframework.transaction.annotation.TransactionAnnotationParser.parseTransactionAnnotation.

Parse the transaction attribute for the given method or class, based on an annotation type understood by this parser.

This essentially parses a known transaction annotation into Spring's metadata attribute class. Returns null if the method/class is not transactional.

Parameters
element:AnnotatedElement

the annotated method or class

Returns:TransactionAttribute

the configured transaction attribute, or null if none found

Annotations
@Override
@Nullable
parseTransactionAnnotationback to summary
public TransactionAttribute parseTransactionAnnotation(TransactionAttribute ann)
org.springframework.transaction.annotation back to summary

private Class Ejb3TransactionAnnotationParser.Ejb3TransactionAttribute

extends DefaultTransactionAttribute
Class Inheritance

EJB3-specific TransactionAttribute, implementing EJB3's rollback rules which are based on annotated exceptions.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
rollbackOn(Throwable
the exception to evaluate
ex
)

Overrides org.springframework.transaction.interceptor.DefaultTransactionAttribute.rollbackOn.

Implements org.springframework.transaction.interceptor.TransactionAttribute.rollbackOn.

The default behavior is as with EJB: rollback on unchecked exception (RuntimeException), assuming an unexpected outcome outside any business rules.
Inherited from org.springframework.transaction.interceptor.DefaultTransactionAttribute:
getAttributeDescriptiongetDescriptorgetLabelsgetQualifiergetTimeoutStringresolveAttributeStringssetDescriptorsetLabelssetQualifiersetTimeoutString

Constructor Detail

Ejb3TransactionAttributeback to summary
public Ejb3TransactionAttribute(TransactionAttributeType type)

Method Detail

rollbackOnback to summary
public boolean rollbackOn(Throwable ex)

Overrides org.springframework.transaction.interceptor.DefaultTransactionAttribute.rollbackOn.

Implements org.springframework.transaction.interceptor.TransactionAttribute.rollbackOn.

Doc from org.springframework.transaction.interceptor.DefaultTransactionAttribute.rollbackOn.

The default behavior is as with EJB: rollback on unchecked exception (RuntimeException), assuming an unexpected outcome outside any business rules. Additionally, we also attempt to rollback on Error which is clearly an unexpected outcome as well. By contrast, a checked exception is considered a business exception and therefore a regular expected outcome of the transactional business method, i.e. a kind of alternative return value which still allows for regular completion of resource operations.

This is largely consistent with TransactionTemplate's default behavior, except that TransactionTemplate also rolls back on undeclared checked exceptions (a corner case). For declarative transactions, we expect checked exceptions to be intentionally declared as business exceptions, leading to a commit by default.

Parameters
ex:Throwable

Doc from org.springframework.transaction.interceptor.TransactionAttribute.rollbackOn.

the exception to evaluate

Returns:boolean

Doc from org.springframework.transaction.interceptor.TransactionAttribute.rollbackOn.

whether to perform a rollback or not

Annotations
@Override