public class

RuleBasedTransactionAttribute

extends DefaultTransactionAttribute
implements Serializable

java.lang.Object
↳	org.springframework.transaction.support.DefaultTransactionDefinition
	↳	org.springframework.transaction.interceptor.DefaultTransactionAttribute
		↳	org.springframework.transaction.interceptor.RuleBasedTransactionAttribute

Class Overview

TransactionAttribute implementation that works out whether a given exception should cause transaction rollback by applying a number of rollback rules, both positive and negative. If no rules are relevant to the exception, it behaves like DefaultTransactionAttribute (rolling back on runtime exceptions).

TransactionAttributeEditor creates objects of this class.

Summary

Constants
String	PREFIX_COMMIT_RULE	Prefix for commit-on-exception rules in description strings
String	PREFIX_ROLLBACK_RULE	Prefix for rollback-on-exception rules in description strings

[Expand]

Inherited Constants

From class org.springframework.transaction.support.DefaultTransactionDefinition

From interface org.springframework.transaction.TransactionDefinition

int	ISOLATION_DEFAULT	Use the default isolation level of the underlying datastore.
int	ISOLATION_READ_COMMITTED	Indicates that dirty reads are prevented; non-repeatable reads and phantom reads can occur.
int	ISOLATION_READ_UNCOMMITTED	Indicates that dirty reads, non-repeatable reads and phantom reads can occur.
int	ISOLATION_REPEATABLE_READ	Indicates that dirty reads and non-repeatable reads are prevented; phantom reads can occur.
int	ISOLATION_SERIALIZABLE	Indicates that dirty reads, non-repeatable reads and phantom reads are prevented.
int	PROPAGATION_MANDATORY	Support a current transaction; throw an exception if no current transaction exists.
int	PROPAGATION_NESTED	Execute within a nested transaction if a current transaction exists, behave like `PROPAGATION_REQUIRED` else.
int	PROPAGATION_NEVER	Do not support a current transaction; throw an exception if a current transaction exists.
int	PROPAGATION_NOT_SUPPORTED	Do not support a current transaction; rather always execute non-transactionally.
int	PROPAGATION_REQUIRED	Support a current transaction; create a new one if none exists.
int	PROPAGATION_REQUIRES_NEW	Create a new transaction, suspending the current transaction if one exists.
int	PROPAGATION_SUPPORTS	Support a current transaction; execute non-transactionally if none exists.
int	TIMEOUT_DEFAULT	Use the default timeout of the underlying transaction system, or none if timeouts are not supported.

Public Constructors
	RuleBasedTransactionAttribute() Create a new RuleBasedTransactionAttribute, with default settings.
	RuleBasedTransactionAttribute(RuleBasedTransactionAttribute other) Copy constructor.
	RuleBasedTransactionAttribute(int propagationBehavior, List<RollbackRuleAttribute> rollbackRules) Create a new DefaultTransactionAttribute with the the given propagation behavior.

Public Methods
List<RollbackRuleAttribute>	getRollbackRules() Return the list of `RollbackRuleAttribute` objects (never `null`).
boolean	rollbackOn(Throwable ex) Winning rule is the shallowest rule (that is, the closest in the inheritance hierarchy to the exception).
void	setRollbackRules(List<RollbackRuleAttribute> rollbackRules) Set the list of `RollbackRuleAttribute` objects (and/or `NoRollbackRuleAttribute` objects) to apply.
String	toString() Return an identifying description for this transaction definition.

[Expand]

Inherited Methods

From class org.springframework.transaction.interceptor.DefaultTransactionAttribute

From class org.springframework.transaction.support.DefaultTransactionDefinition

boolean	equals(Object other) This implementation compares the `toString()` results.
final StringBuilder	getDefinitionDescription() Return an identifying description for this transaction definition.
final int	getIsolationLevel() Return the isolation level.
final String	getName() Return the name of this transaction.
final int	getPropagationBehavior() Return the propagation behavior.
final int	getTimeout() Return the transaction timeout.
int	hashCode() This implementation returns `toString()`'s hash code.
final boolean	isReadOnly() Return whether to optimize as a read-only transaction.
final void	setIsolationLevel(int isolationLevel) Set the isolation level.
final void	setIsolationLevelName(String constantName) Set the isolation level by the name of the corresponding constant in TransactionDefinition, e.g.
final void	setName(String name) Set the name of this transaction.
final void	setPropagationBehavior(int propagationBehavior) Set the propagation behavior.
final void	setPropagationBehaviorName(String constantName) Set the propagation behavior by the name of the corresponding constant in TransactionDefinition, e.g.
final void	setReadOnly(boolean readOnly) Set whether to optimize as read-only transaction.
final void	setTimeout(int timeout) Set the timeout to apply, as number of seconds.
String	toString() Return an identifying description for this transaction definition.

From class java.lang.Object

From interface org.springframework.transaction.TransactionDefinition

From interface org.springframework.transaction.interceptor.TransactionAttribute

Constants

public static final String PREFIX_COMMIT_RULE

Prefix for commit-on-exception rules in description strings

Constant Value: "+"

public static final String PREFIX_ROLLBACK_RULE

Prefix for rollback-on-exception rules in description strings

Constant Value: "-"

Public Constructors

public RuleBasedTransactionAttribute ()

Create a new RuleBasedTransactionAttribute, with default settings. Can be modified through bean property setters.

public RuleBasedTransactionAttribute (RuleBasedTransactionAttribute other)

Copy constructor. Definition can be modified through bean property setters.

public RuleBasedTransactionAttribute (int propagationBehavior, List<RollbackRuleAttribute> rollbackRules)

Create a new DefaultTransactionAttribute with the the given propagation behavior. Can be modified through bean property setters.

Parameters

propagationBehavior	one of the propagation constants in the TransactionDefinition interface
rollbackRules	the list of RollbackRuleAttributes to apply

Public Methods

public List<RollbackRuleAttribute> getRollbackRules ()

Return the list of RollbackRuleAttribute objects (never null).

public boolean rollbackOn (Throwable ex)

Winning rule is the shallowest rule (that is, the closest in the inheritance hierarchy to the exception). If no rule applies (-1), return false.

Parameters

ex	the exception to evaluate

Returns

whether to perform a rollback or not

public void setRollbackRules (List<RollbackRuleAttribute> rollbackRules)

Set the list of RollbackRuleAttribute objects (and/or NoRollbackRuleAttribute objects) to apply.

public String toString ()

Return an identifying description for this transaction definition.

The format matches the one used by TransactionAttributeEditor, to be able to feed toString results into bean properties of type TransactionAttribute.

Has to be overridden in subclasses for correct equals and hashCode behavior. Alternatively, equals(Object) and hashCode() can be overridden themselves.

Interfaces

Classes

RuleBasedTransactionAttribute

Class Overview

See Also

Summary

Constants

public static final String PREFIX_COMMIT_RULE

public static final String PREFIX_ROLLBACK_RULE

Public Constructors

public RuleBasedTransactionAttribute ()

See Also

public RuleBasedTransactionAttribute (RuleBasedTransactionAttribute other)

See Also

public RuleBasedTransactionAttribute (int propagationBehavior, List<RollbackRuleAttribute> rollbackRules)

Parameters

See Also

Public Methods

public List<RollbackRuleAttribute> getRollbackRules ()

public boolean rollbackOn (Throwable ex)

Parameters

Returns

See Also

public void setRollbackRules (List<RollbackRuleAttribute> rollbackRules)

See Also

public String toString ()