org.seasar.doma.jdbc.tx

Class LocalTransactionManager

java.lang.Object

org.seasar.doma.jdbc.tx.LocalTransactionManager

All Implemented Interfaces:

TransactionManager

public class LocalTransactionManager
extends java.lang.Object
implements TransactionManager

A transaction manager for local transactions.

This instance is thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
protected LocalTransaction	transaction

Constructor Summary

Constructors

Constructor and Description
LocalTransactionManager(LocalTransaction transaction) Create an instance.
LocalTransactionManager(LocalTransactionDataSource dataSource, JdbcLogger jdbcLogger) Create an instance.
LocalTransactionManager(LocalTransactionDataSource dataSource, JdbcLogger jdbcLogger, TransactionIsolationLevel isolationLevel) Create an instance.

Method Summary

Modifier and Type	Method and Description
protected <RESULT> RESULT	executeInTransaction(TransactionIsolationLevel isolationLevel, java.util.function.Supplier<RESULT> supplier)
LocalTransaction	getTransaction() Returns the transaction.
boolean	hasSavepoint(java.lang.String savepointName) Whether the current transaction has the save point.
boolean	isRollbackOnly() Whether the current transaction is marked to be undone.
void	notSupported(java.lang.Runnable block) Executes the transaction whose attribute is NOT_SUPPORTED.
<RESULT> RESULT	notSupported(java.util.function.Supplier<RESULT> supplier) Executes the transaction whose attribute is NOT_SUPPORTED and returns the result.
void	notSupported(TransactionIsolationLevel isolationLevel, java.lang.Runnable block) Executes the transaction whose attribute is NOT_SUPPORTED with the specified transaction isolation level.
<RESULT> RESULT	notSupported(TransactionIsolationLevel isolationLevel, java.util.function.Supplier<RESULT> supplier) Executes the transaction whose attribute is NOT_SUPPORTED with the specified transaction isolation level and return the result.
protected <RESULT> RESULT	notSupportedInternal(TransactionIsolationLevel isolationLevel, java.util.function.Supplier<RESULT> supplier)
void	releaseSavepoint(java.lang.String savepointName) Removes the specified save point and subsequent save points from the current transaction.
void	required(java.lang.Runnable block) Executes the transaction whose attribute is REQUIRED.
<RESULT> RESULT	required(java.util.function.Supplier<RESULT> supplier) Executes the transaction whose attribute is REQUIRED and returns the result.
void	required(TransactionIsolationLevel isolationLevel, java.lang.Runnable block) Executes the transaction whose attribute is REQUIRED with the specified transaction isolation level.
<RESULT> RESULT	required(TransactionIsolationLevel isolationLevel, java.util.function.Supplier<RESULT> supplier) Executes the transaction whose attribute is REQUIRED with the specified transaction isolation level and return the result.
protected <RESULT> RESULT	requiredInternal(TransactionIsolationLevel isolationLevel, java.util.function.Supplier<RESULT> supplier)
void	requiresNew(java.lang.Runnable block) Executes the transaction whose attribute is REQUIRES_NEW.
<RESULT> RESULT	requiresNew(java.util.function.Supplier<RESULT> supplier) Executes the transaction whose attribute is REQUIRES_NEW and returns the result.
void	requiresNew(TransactionIsolationLevel isolationLevel, java.lang.Runnable block) Executes the transaction whose attribute is REQUIRES_NEW with the specified transaction isolation level.
<RESULT> RESULT	requiresNew(TransactionIsolationLevel isolationLevel, java.util.function.Supplier<RESULT> supplier) Executes the transaction whose attribute is REQUIRES_NEW with the specified transaction isolation level and return the result.
protected <RESULT> RESULT	requiresNewInternal(TransactionIsolationLevel isolationLevel, java.util.function.Supplier<RESULT> supplier)
void	rollback(java.lang.String savepointName) Undoes all changes made after the given save point.
void	setRollbackOnly() Marks the current transaction to undo in the end of the transaction.
void	setSavepoint(java.lang.String savepointName) Creates a save point with the specified name.
protected java.util.function.Supplier<java.lang.Void>	toSupplier(java.lang.Runnable block)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

transaction

protected final LocalTransaction transaction

Constructor Detail

LocalTransactionManager

public LocalTransactionManager(LocalTransaction transaction)

Create an instance.

Parameters:

transaction - the transaction

Throws:

DomaNullPointerException - if the transaction is null

LocalTransactionManager

public LocalTransactionManager(LocalTransactionDataSource dataSource,
                               JdbcLogger jdbcLogger)

Create an instance.

Parameters:

dataSource - the data source

jdbcLogger - the logger

Throws:

DomaNullPointerException - if any of the parameters are null

LocalTransactionManager

public LocalTransactionManager(LocalTransactionDataSource dataSource,
                               JdbcLogger jdbcLogger,
                               TransactionIsolationLevel isolationLevel)

Create an instance.

Parameters:

dataSource - the data source

jdbcLogger - the logger

isolationLevel - the default transaction isolation level

Throws:

DomaNullPointerException - if any of the parameters are null

Method Detail

getTransaction

public LocalTransaction getTransaction()

Returns the transaction.

This method is mainly used in test code.

Returns:

the transaction

required

public void required(java.lang.Runnable block)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is REQUIRED.

Specified by:

required in interface TransactionManager

Parameters:

block - the code that is executed in the transaction

required

public void required(TransactionIsolationLevel isolationLevel,
                     java.lang.Runnable block)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is REQUIRED with the specified transaction isolation level.

Specified by:

required in interface TransactionManager

Parameters:

isolationLevel - the transaction isolation level

block - the code that is executed in the transaction

required

public <RESULT> RESULT required(java.util.function.Supplier<RESULT> supplier)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is REQUIRED and returns the result.

Specified by:

required in interface TransactionManager

Type Parameters:

RESULT - the result type

Parameters:

supplier - the code that is executed in the transaction

Returns:

the result

required

public <RESULT> RESULT required(TransactionIsolationLevel isolationLevel,
                                java.util.function.Supplier<RESULT> supplier)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is REQUIRED with the specified transaction isolation level and return the result.

Specified by:

required in interface TransactionManager

Type Parameters:

RESULT - the result type

Parameters:

isolationLevel - the transaction isolation level

supplier - the code that is executed in the transaction

Returns:

the result

requiredInternal

protected <RESULT> RESULT requiredInternal(TransactionIsolationLevel isolationLevel,
                                           java.util.function.Supplier<RESULT> supplier)

requiresNew

public void requiresNew(java.lang.Runnable block)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is REQUIRES_NEW.

Specified by:

requiresNew in interface TransactionManager

Parameters:

block - the code that is executed in the transaction

requiresNew

public void requiresNew(TransactionIsolationLevel isolationLevel,
                        java.lang.Runnable block)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is REQUIRES_NEW with the specified transaction isolation level.

Specified by:

requiresNew in interface TransactionManager

Parameters:

isolationLevel - the transaction isolation level

block - the code that is executed in the transaction

requiresNew

public <RESULT> RESULT requiresNew(java.util.function.Supplier<RESULT> supplier)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is REQUIRES_NEW and returns the result.

Specified by:

requiresNew in interface TransactionManager

Type Parameters:

RESULT - the result type

Parameters:

supplier - the code that is executed in the transaction

Returns:

the result

requiresNew

public <RESULT> RESULT requiresNew(TransactionIsolationLevel isolationLevel,
                                   java.util.function.Supplier<RESULT> supplier)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is REQUIRES_NEW with the specified transaction isolation level and return the result.

Specified by:

requiresNew in interface TransactionManager

Type Parameters:

RESULT - the result type

Parameters:

isolationLevel - the transaction isolation level

supplier - the code that is executed in the transaction

Returns:

the result

requiresNewInternal

protected <RESULT> RESULT requiresNewInternal(TransactionIsolationLevel isolationLevel,
                                              java.util.function.Supplier<RESULT> supplier)

notSupported

public void notSupported(java.lang.Runnable block)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is NOT_SUPPORTED.

Specified by:

notSupported in interface TransactionManager

Parameters:

block - the code that is executed in the transaction

notSupported

public void notSupported(TransactionIsolationLevel isolationLevel,
                         java.lang.Runnable block)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is NOT_SUPPORTED with the specified transaction isolation level.

Specified by:

notSupported in interface TransactionManager

Parameters:

isolationLevel - the transaction isolation level

block - the code that is executed in the transaction

notSupported

public <RESULT> RESULT notSupported(java.util.function.Supplier<RESULT> supplier)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is NOT_SUPPORTED and returns the result.

Specified by:

notSupported in interface TransactionManager

Type Parameters:

RESULT - the result type

Parameters:

supplier - the code that is executed in the transaction

Returns:

the result

notSupported

public <RESULT> RESULT notSupported(TransactionIsolationLevel isolationLevel,
                                    java.util.function.Supplier<RESULT> supplier)

Description copied from interface: TransactionManager

Executes the transaction whose attribute is NOT_SUPPORTED with the specified transaction isolation level and return the result.

Specified by:

notSupported in interface TransactionManager

Type Parameters:

RESULT - the result type

Parameters:

isolationLevel - the transaction isolation level

supplier - the code that is executed in the transaction

Returns:

the result

notSupportedInternal

protected <RESULT> RESULT notSupportedInternal(TransactionIsolationLevel isolationLevel,
                                               java.util.function.Supplier<RESULT> supplier)

toSupplier

protected java.util.function.Supplier<java.lang.Void> toSupplier(java.lang.Runnable block)

setRollbackOnly

public void setRollbackOnly()

Description copied from interface: TransactionManager

Marks the current transaction to undo in the end of the transaction.

Specified by:

setRollbackOnly in interface TransactionManager

isRollbackOnly

public boolean isRollbackOnly()

Description copied from interface: TransactionManager

Whether the current transaction is marked to be undone.

Specified by:

isRollbackOnly in interface TransactionManager

Returns:

true if the current transaction is marked.

executeInTransaction

protected <RESULT> RESULT executeInTransaction(TransactionIsolationLevel isolationLevel,
                                               java.util.function.Supplier<RESULT> supplier)

setSavepoint

public void setSavepoint(java.lang.String savepointName)

Description copied from interface: TransactionManager

Creates a save point with the specified name.

Begin a transaction before invoking this method.

Specified by:

setSavepoint in interface TransactionManager

Parameters:

savepointName - the name of the save point

hasSavepoint

public boolean hasSavepoint(java.lang.String savepointName)

Description copied from interface: TransactionManager

Whether the current transaction has the save point.

Begin a transaction before invoking this method.

Specified by:

hasSavepoint in interface TransactionManager

Parameters:

savepointName - the name of the save point

Returns:

true if the transaction has the save point

releaseSavepoint

public void releaseSavepoint(java.lang.String savepointName)

Description copied from interface: TransactionManager

Removes the specified save point and subsequent save points from the current transaction.

Begin a transaction before invoking this method.

Specified by:

releaseSavepoint in interface TransactionManager

Parameters:

savepointName - the name of the save point

rollback

public void rollback(java.lang.String savepointName)

Description copied from interface: TransactionManager

Undoes all changes made after the given save point.

Begin a transaction before invoking this method.

Specified by:

rollback in interface TransactionManager

Parameters:

savepointName - the name of the save point