org.seasar.doma.jdbc.tx

Class LocalTransaction

java.lang.Object

org.seasar.doma.jdbc.tx.LocalTransaction

Direct Known Subclasses:

KeepAliveLocalTransaction

public class LocalTransaction
extends java.lang.Object

A local transaction.

This instance is thread safe.

Begin a transaction by begin() or begin(TransactionIsolationLevel) and end the transaction always by commit() or rollback().

 LocalTransaction tx = DbConfig.singleton().getLocalTransaction();
 try {
     tx.begin();

     Employee employee = dao.selectById(1);
     employee.setName("SMITH");
     employee.setJobType(JobType.PRESIDENT);
     dao.update(employee);

     tx.commit();
 } finally {
     tx.rollback();
 }
 

Same instance can handle multiple transactions sequentially.

 Db
 LocalTransaction tx = DbConfig.singleton().getLocalTransaction();
 // transaction 1
 try {
     tx.begin();
     ...
     tx.commit();
 } finally {
     tx.rollback();
 }
 // transaction 2
 try {
     tx.begin();
     ...
     tx.commit();
 } finally {
     tx.rollback();
 }
 

Any exceptions that are thrown from this class methods roll back the transaction.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	className
protected javax.sql.DataSource	dataSource
protected TransactionIsolationLevel	defaultTransactionIsolationLevel
protected JdbcLogger	jdbcLogger
protected java.lang.ThreadLocal<LocalTransactionContext>	localTxContextHolder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalTransaction(javax.sql.DataSource dataSource, java.lang.ThreadLocal<LocalTransactionContext> localTxContextHolder, JdbcLogger jdbcLogger)
protected	LocalTransaction(javax.sql.DataSource dataSource, java.lang.ThreadLocal<LocalTransactionContext> localTxContextHolder, JdbcLogger jdbcLogger, TransactionIsolationLevel defaultTransactionIsolationLevel)

Method Summary

Modifier and Type	Method and Description
void	begin() Begin this transaction.
void	begin(TransactionIsolationLevel transactionIsolationLevel) Begin this transaction with the specified transaction isolation level.
protected void	beginInternal(TransactionIsolationLevel transactionIsolationLevel, java.lang.String callerMethodName)
protected void	closeConnection(java.sql.Connection connection)
void	commit() Commits this transaction.
protected void	end(java.lang.String callerMethodName)
protected void	endInternal(LocalTransactionContext context, java.lang.String callerMethodName)
protected LocalTransactionContext	getLocalTransactionContext()
boolean	hasSavepoint(java.lang.String savepointName) Whether this transaction has the specified save point.
boolean	isActive() Whether this transaction is active.
protected boolean	isActiveInternal(LocalTransactionContext context)
boolean	isRollbackOnly() Whether this transaction is marked to be undone.
protected void	release(LocalTransactionContext context, java.lang.String callerMethodName) Releases the transaction context.
void	releaseSavepoint(java.lang.String savepointName) Removes the specified save point and subsequent save points from this transaction.
void	resume(LocalTransactionContext context) Resumes this transaction.
void	rollback() Undoes all changes made in this transaction.
void	rollback(java.lang.String savepointName) Undoes all changes made after the given save point.
protected void	rollbackInternal(java.lang.String callerMethodName)
void	setRollbackOnly() Marks this transaction to undo in the end of the transaction.
void	setSavepoint(java.lang.String savepointName) Creates a save point with the specified name.
LocalTransactionContext	suspend() Suspends this transaction.
java.lang.String	toString() Returns an unique string to identify this transaction.

Methods inherited from class java.lang.Object

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

Field Detail

dataSource

protected final javax.sql.DataSource dataSource

localTxContextHolder

protected final java.lang.ThreadLocal<LocalTransactionContext> localTxContextHolder

jdbcLogger

protected final JdbcLogger jdbcLogger

defaultTransactionIsolationLevel

protected final TransactionIsolationLevel defaultTransactionIsolationLevel

className

protected final java.lang.String className

Constructor Detail

LocalTransaction

protected LocalTransaction(javax.sql.DataSource dataSource,
                           java.lang.ThreadLocal<LocalTransactionContext> localTxContextHolder,
                           JdbcLogger jdbcLogger)

LocalTransaction

protected LocalTransaction(javax.sql.DataSource dataSource,
                           java.lang.ThreadLocal<LocalTransactionContext> localTxContextHolder,
                           JdbcLogger jdbcLogger,
                           TransactionIsolationLevel defaultTransactionIsolationLevel)

Method Detail

begin

public void begin()

Begin this transaction.

Throws:

TransactionAlreadyBegunException - if this transaction is already begun

JdbcException - if a JDBC related error occurs

begin

public void begin(TransactionIsolationLevel transactionIsolationLevel)

Begin this transaction with the specified transaction isolation level.

Parameters:

transactionIsolationLevel - the transaction isolation level

Throws:

DomaNullPointerException - if the transactionIsolationLevel is null

TransactionAlreadyBegunException - if this transaction is already begun

JdbcException - if a JDBC related error occurs

beginInternal

protected void beginInternal(TransactionIsolationLevel transactionIsolationLevel,
                             java.lang.String callerMethodName)

getLocalTransactionContext

protected LocalTransactionContext getLocalTransactionContext()

commit

public void commit()

Commits this transaction.

Throws:

TransactionNotYetBegunException - if this transaction is not yet begun

JdbcException - if a JDBC related error occurs

suspend

public LocalTransactionContext suspend()

Suspends this transaction.

Returns:

the transaction context that is required to resume this transaction

Throws:

TransactionNotYetBegunException - if this transaction is not yet begun

resume

public void resume(LocalTransactionContext context)

Resumes this transaction.

This method does not throw any exceptions.

Parameters:

context - the transaction context that is returned from suspend()

rollback

public void rollback()

Undoes all changes made in this transaction.

If this transaction is not begun, this method does nothing.

This method does not throw any exceptions.

rollbackInternal

protected void rollbackInternal(java.lang.String callerMethodName)

setSavepoint

public void setSavepoint(java.lang.String savepointName)

Creates a save point with the specified name.

Parameters:

savepointName - the name of the save point

Throws:

DomaNullPointerException - if the savepointName is null

TransactionNotYetBegunException - if this transaction is not yet begun

SavepointAlreadyExistsException - if the save point already exists

JdbcException - if a JDBC related error occurs

hasSavepoint

public boolean hasSavepoint(java.lang.String savepointName)

Whether this transaction has the specified save point.

Parameters:

savepointName - the name of the save point

Returns:

true if this transaction has the save point

Throws:

DomaNullPointerException - if the savepointName is null

TransactionNotYetBegunException - if this transaction is not yet begun

releaseSavepoint

public void releaseSavepoint(java.lang.String savepointName)

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

Parameters:

savepointName - the name of the save point

Throws:

DomaNullPointerException - if the savepointName is null

TransactionNotYetBegunException - if this transaction is not yet begun

JdbcException - if a JDBC related error occurs

rollback

public void rollback(java.lang.String savepointName)

Undoes all changes made after the given save point.

Parameters:

savepointName - the name of the save point

Throws:

DomaNullPointerException - if the savepointName is null

SavepointNotFoundException - if the save point is not found

TransactionNotYetBegunException - if this transaction is not yet begun

JdbcException - if a JDBC related error occurs

end

protected void end(java.lang.String callerMethodName)

endInternal

protected void endInternal(LocalTransactionContext context,
                           java.lang.String callerMethodName)

release

protected void release(LocalTransactionContext context,
                       java.lang.String callerMethodName)

Releases the transaction context.

This method does not throw any exceptions.

Parameters:

context - the transaction context

callerMethodName - the caller method name

closeConnection

protected void closeConnection(java.sql.Connection connection)

toString

public java.lang.String toString()

Returns an unique string to identify this transaction.

Overrides:

toString in class java.lang.Object

isActive

public boolean isActive()

Whether this transaction is active.

Returns:

true if this transaction is active

isActiveInternal

protected boolean isActiveInternal(LocalTransactionContext context)

setRollbackOnly

public void setRollbackOnly()

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

isRollbackOnly

public boolean isRollbackOnly()

Whether this transaction is marked to be undone.

Returns:

true if the current transaction is marked.