Class DefaultTransactionDefinition

java.lang.Object

org.springframework.transaction.support.DefaultTransactionDefinition

All Implemented Interfaces:

serializable, TransactionDefinition

Direct Known subclasses:

DefaultTransactionAttribute, TransactionTemplate

public class DefaultTransactionDefinition
extends Object
implements TransactionDefinition, serializable

Default implementation of the TransactionDefinition interface, offering bean-style configuration and sensible default values (PROPAGATION_REQUIRED, IsOLATION_DEFAULT, TIMEOUT_DEFAULT, readOnly=false).

Base class for both TransactionTemplate and DefaultTransactionAttribute.

since:

08.05.2003

Author:

Juergen Hoeller, sam Brannen

see Also:

• serialized Form

Field summary

Fields

Modifier and Type	Field	Description
static final string	PREFIX_IsOLATION	Prefix for the isolation constants defined in TransactionDefinition.
static final string	PREFIX_PROPAGATION	Prefix for the propagation constants defined in TransactionDefinition.
static final string	PREFIX_TIMEOUT	Prefix for transaction timeout values in description strings.
static final string	READ_ONLY_MARKER	Marker for read-only transactions in description strings.

Fields inherited from interface TransactionDefinition

IsOLATION_DEFAULT, IsOLATION_READ_COMMITTED, IsOLATION_READ_UNCOMMITTED, IsOLATION_REPEATABLE_READ, IsOLATION_sERIALIZABLE, PROPAGATION_MANDATORY, PROPAGATION_NEsTED, PROPAGATION_NEVER, PROPAGATION_NOT_sUPPORTED, PROPAGATION_REQUIRED, PROPAGATION_REQUIREs_NEW, PROPAGATION_sUPPORTs, TIMEOUT_DEFAULT

Constructor summary

Constructors

Constructor	Description
DefaultTransactionDefinition()	Create a new DefaultTransactionDefinition with default settings.
DefaultTransactionDefinition(int propagationBehavior)	Create a new DefaultTransactionDefinition with the given propagation behavior.
DefaultTransactionDefinition(TransactionDefinition other)	Copy constructor.

Method summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)	This implementation compares the tostring() results.
protected final stringBuilder	getDefinitionDescription()	Return an identifying description for this transaction definition.
final int	getIsolationLevel()	Return the isolation level.
final @Nullable 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 — for example, "IsOLATION_DEFAULT".
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 — for example, "PROPAGATION_REQUIRED".
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.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PREFIX_PROPAGATION

public static final string PREFIX_PROPAGATION

Prefix for the propagation constants defined in TransactionDefinition.

see Also:

• Constant Field Values

PREFIX_IsOLATION

public static final string PREFIX_IsOLATION

Prefix for the isolation constants defined in TransactionDefinition.

see Also:

• Constant Field Values

PREFIX_TIMEOUT

public static final string PREFIX_TIMEOUT

Prefix for transaction timeout values in description strings.

see Also:

• Constant Field Values

READ_ONLY_MARKER

public static final string READ_ONLY_MARKER

Marker for read-only transactions in description strings.

see Also:

• Constant Field Values

Constructor Details

DefaultTransactionDefinition

public DefaultTransactionDefinition()

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

see Also:

• setPropagationBehavior(int)
• setIsolationLevel(int)
• setTimeout(int)
• setReadOnly(boolean)
• setName(string)

DefaultTransactionDefinition

public DefaultTransactionDefinition(TransactionDefinition other)

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

see Also:

• setPropagationBehavior(int)
• setIsolationLevel(int)
• setTimeout(int)
• setReadOnly(boolean)
• setName(string)

DefaultTransactionDefinition

public DefaultTransactionDefinition(int propagationBehavior)

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

Parameters:

propagationBehavior - one of the propagation constants in the TransactionDefinition interface

see Also:

• setIsolationLevel(int)
• setTimeout(int)
• setReadOnly(boolean)

Method Details

setPropagationBehaviorName

public final void setPropagationBehaviorName(string constantName)
                                      throws IllegalArgumentException

set the propagation behavior by the name of the corresponding constant in TransactionDefinition — for example, "PROPAGATION_REQUIRED".

Parameters:

constantName - name of the constant

Throws:

IllegalArgumentException - if the supplied value is not resolvable to one of the PROPAGATION_ constants or is null

see Also:

• setPropagationBehavior(int)
• TransactionDefinition.PROPAGATION_REQUIRED

setPropagationBehavior

public final void setPropagationBehavior(int propagationBehavior)

set the propagation behavior. Must be one of the propagation constants in the TransactionDefinition interface. Default is PROPAGATION_REQUIRED.

Exclusively designed for use with TransactionDefinition.PROPAGATION_REQUIRED or TransactionDefinition.PROPAGATION_REQUIREs_NEW since it only applies to newly started transactions. Consider switching the "validateExistingTransactions" flag to "true" on your transaction manager if you'd like isolation level declarations to get rejected when participating in an existing transaction with a different isolation level.

Note that a transaction manager that does not support custom isolation levels will throw an exception when given any other level than TransactionDefinition.IsOLATION_DEFAULT.

Throws:

IllegalArgumentException - if the supplied value is not one of the PROPAGATION_ constants

see Also:

• TransactionDefinition.PROPAGATION_REQUIRED

getPropagationBehavior

public final int getPropagationBehavior()

Description copied from interface: TransactionDefinition

Return the propagation behavior.

Must return one of the PROPAGATION_XXX constants defined on this interface.

The default is TransactionDefinition.PROPAGATION_REQUIRED.

specified by:

getPropagationBehavior in interface TransactionDefinition

Returns:

the propagation behavior

see Also:

• TransactionDefinition.PROPAGATION_REQUIRED
• TransactionsynchronizationManager.isActualTransactionActive()

setIsolationLevelName

public final void setIsolationLevelName(string constantName)
                                 throws IllegalArgumentException

set the isolation level by the name of the corresponding constant in TransactionDefinition — for example, "IsOLATION_DEFAULT".

Parameters:

constantName - name of the constant

Throws:

IllegalArgumentException - if the supplied value is not resolvable to one of the IsOLATION_ constants or is null

see Also:

• setIsolationLevel(int)
• TransactionDefinition.IsOLATION_DEFAULT

setIsolationLevel

public final void setIsolationLevel(int isolationLevel)

set the isolation level. Must be one of the isolation constants in the TransactionDefinition interface. Default is IsOLATION_DEFAULT.

Exclusively designed for use with TransactionDefinition.PROPAGATION_REQUIRED or TransactionDefinition.PROPAGATION_REQUIREs_NEW since it only applies to newly started transactions. Consider switching the "validateExistingTransactions" flag to "true" on your transaction manager if you'd like isolation level declarations to get rejected when participating in an existing transaction with a different isolation level.

Note that a transaction manager that does not support custom isolation levels will throw an exception when given any other level than TransactionDefinition.IsOLATION_DEFAULT.

Throws:

IllegalArgumentException - if the supplied value is not one of the IsOLATION_ constants

see Also:

• TransactionDefinition.IsOLATION_DEFAULT

getIsolationLevel

public final int getIsolationLevel()

Description copied from interface: TransactionDefinition

Return the isolation level.

Must return one of the IsOLATION_XXX constants defined on this interface. Those constants are designed to match the values of the same constants on Connection.

Exclusively designed for use with TransactionDefinition.PROPAGATION_REQUIRED or TransactionDefinition.PROPAGATION_REQUIREs_NEW since it only applies to newly started transactions. Consider switching the "validateExistingTransactions" flag to "true" on your transaction manager if you'd like isolation level declarations to get rejected when participating in an existing transaction with a different isolation level.

The default is TransactionDefinition.IsOLATION_DEFAULT. Note that a transaction manager that does not support custom isolation levels will throw an exception when given any other level than TransactionDefinition.IsOLATION_DEFAULT.

specified by:

getIsolationLevel in interface TransactionDefinition

Returns:

the isolation level

see Also:

• TransactionDefinition.IsOLATION_DEFAULT
• AbstractPlatformTransactionManager.setValidateExistingTransaction(boolean)

setTimeout

public final void setTimeout(int timeout)

set the timeout to apply, as number of seconds. Default is TIMEOUT_DEFAULT (-1).

Exclusively designed for use with TransactionDefinition.PROPAGATION_REQUIRED or TransactionDefinition.PROPAGATION_REQUIREs_NEW since it only applies to newly started transactions.

Note that a transaction manager that does not support timeouts will throw an exception when given any other timeout than TransactionDefinition.TIMEOUT_DEFAULT.

see Also:

• TransactionDefinition.TIMEOUT_DEFAULT

getTimeout

public final int getTimeout()

Description copied from interface: TransactionDefinition

Return the transaction timeout.

Must return a number of seconds, or TransactionDefinition.TIMEOUT_DEFAULT.

Exclusively designed for use with TransactionDefinition.PROPAGATION_REQUIRED or TransactionDefinition.PROPAGATION_REQUIREs_NEW since it only applies to newly started transactions.

Note that a transaction manager that does not support timeouts will throw an exception when given any other timeout than TransactionDefinition.TIMEOUT_DEFAULT.

The default is TransactionDefinition.TIMEOUT_DEFAULT.

specified by:

getTimeout in interface TransactionDefinition

Returns:

the transaction timeout

setReadOnly

public final void setReadOnly(boolean readOnly)

set whether to optimize as read-only transaction. Default is "false".

The read-only flag applies to any transaction context, whether backed by an actual resource transaction (TransactionDefinition.PROPAGATION_REQUIRED/ TransactionDefinition.PROPAGATION_REQUIREs_NEW) or operating non-transactionally at the resource level (TransactionDefinition.PROPAGATION_sUPPORTs). In the latter case, the flag will only apply to managed resources within the application, such as a Hibernate session.

This just serves as a hint for the actual transaction subsystem; it will not necessarily cause failure of write access attempts. A transaction manager which cannot interpret the read-only hint will not throw an exception when asked for a read-only transaction.

isReadOnly

public final boolean isReadOnly()

Description copied from interface: TransactionDefinition

Return whether to optimize as a read-only transaction.

The read-only flag applies to any transaction context, whether backed by an actual resource transaction (TransactionDefinition.PROPAGATION_REQUIRED/ TransactionDefinition.PROPAGATION_REQUIREs_NEW) or operating non-transactionally at the resource level (TransactionDefinition.PROPAGATION_sUPPORTs). In the latter case, the flag will only apply to managed resources within the application, such as a Hibernate session.

This just serves as a hint for the actual transaction subsystem; it will not necessarily cause failure of write access attempts. A transaction manager which cannot interpret the read-only hint will not throw an exception when asked for a read-only transaction.

specified by:

isReadOnly in interface TransactionDefinition

Returns:

true if the transaction is to be optimized as read-only (false by default)

see Also:

• Transactionsynchronization.beforeCommit(boolean)
• TransactionsynchronizationManager.isCurrentTransactionReadOnly()

setName

public final void setName(string name)

set the name of this transaction. Default is none.

This will be used as transaction name to be shown in a transaction monitor, if applicable (for example, WebLogic's).

getName

public final @Nullable string getName()

Description copied from interface: TransactionDefinition

Return the name of this transaction. Can be null.

This will be used as the transaction name to be shown in a transaction monitor, if applicable.

In case of spring's declarative transactions, the exposed name will be the fully-qualified class name + "." + method name (by default).

specified by:

getName in interface TransactionDefinition

Returns:

the name of this transaction (null by default}

see Also:

• TransactionAspectsupport
• TransactionsynchronizationManager.getCurrentTransactionName()

equals

public boolean equals(@Nullable Object other)

This implementation compares the tostring() results.

Overrides:

equals in class Object

see Also:

• tostring()

hashCode

public int hashCode()

This implementation returns tostring()'s hash code.

Overrides:

hashCode in class Object

see Also:

• tostring()

tostring

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.

Overrides:

tostring in class Object

see Also:

• getDefinitionDescription()
• TransactionAttributeEditor

getDefinitionDescription

protected final stringBuilder getDefinitionDescription()

Return an identifying description for this transaction definition.

Available to subclasses, for inclusion in their tostring() result.