Package org.iplass.mtp.transaction
Interface Transaction
- All Known Implementing Classes:
NoTransaction
public interface Transaction
トランザクションを表すインタフェースです。
トランザクションを制御するためのメソッドを持っています。
トランザクション制御コード例
※現在起動中のトランザクションと別に新規にトランザクション処理を起動する場合
EntityManager em = ...
Entity e = ...
//新規にトランザクションを起動
Transaction.requiresNew(t -> {
em.insert(e);
//コミット成功時に実行する処理を追加
t.afterCommit(() -> {
System.out.println("committed");
});
:
:
});
-
Field Summary
Fields Modifier and Type Field Description static TransactionNO_TRANSACTIONトランザクションがない状態を表すTransactionのインスタンスです。 トランザクションがまだ開始されていない状態、もしくはトランザクションがサスペンドされている場合に当インスタンスが返却されます。
getStatus()は常にTransactionStatus.NONEを返します。
setAttribute(Object, Object)などのその他のトランザクション制御メソッドはなにも処理しません。 -
Method Summary
Modifier and Type Method Description voidaddTransactionListener(TransactionListener listener)このトランザクションのcommit、rollbackを監視するリスナーを登録します。default voidafterCommit(java.lang.Runnable func)このトランザクションがcommitされた場合、funcを実行します。 funcの引数にはこのトランザクションが渡されます。default voidafterRollback(java.lang.Runnable func)このトランザクションがrollbackされた場合、funcを実行します。 funcの引数にはこのトランザクションが渡されます。voidcommit()トランザクションをコミットします。java.lang.ObjectgetAttribute(java.lang.Object key)このトランザクションコンテキストに紐づけられている特定の属性を取得します。 同一トランザクション内でsetAttribute()したものがあれば、その値が取得できます。static TransactiongetCurrent()現在の実行コンテキストに関連しているトランザクションのインスタンスを取得します。 もし、トランザクションが開始されていない場合は、NO_TRANSACTIONが返却されます。TransactionStatusgetStatus()トランザクションの状態を取得します。booleanisReadOnly()このトランザクションがReadOnlyとしてマークされているかどうかを取得します。booleanisRollbackOnly()このトランザクションがsetRollbackOnlyされているかどうかを取得します。static voidreadOnly(java.util.function.Consumer<Transaction> func)トランザクションをreadOnlyモードで起動します。 ただし、すでにトランザクションが開始されている場合、 新規にトランザクションは開始せず既存のトランザクションをそのまま利用します。 これは、
TransactionOption.propagation=REQUIRED
TransactionOption.readOnly=true
でトランザクションを起動することを示します。static <R> RreadOnly(java.util.function.Function<Transaction,R> func)トランザクションをreadOnlyモードで起動します。 ただし、すでにトランザクションが開始されている場合、 新規にトランザクションは開始せず既存のトランザクションをそのまま利用します。 これは、
TransactionOption.propagation=REQUIRED
TransactionOption.readOnly=true
でトランザクションを起動することを示します。java.lang.ObjectremoveAttribute(java.lang.Object key)このトランザクションコンテキストに紐づけられている特定の属性を削除します。static voidrequired(java.util.function.Consumer<Transaction> func)トランザクションが開始していない場合はトランザクションを起動し、funcを実行します。 トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。static <R> Rrequired(java.util.function.Function<Transaction,R> func)トランザクションが開始していない場合はトランザクションを起動し、funcを実行します。 トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。static voidrequiresNew(java.util.function.Consumer<Transaction> func)新規にトランザクションを起動し、funcを実行します。 トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。static <R> RrequiresNew(java.util.function.Function<Transaction,R> func)新規にトランザクションを起動し、funcを実行します。 トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。voidrollback()トランザクションをロールバックします。voidsetAttribute(java.lang.Object key, java.lang.Object value)このトランザクションのコンテキストに特定の属性を紐づけます。voidsetRollbackOnly()このトランザクションをロールバックするものとしてマークします。 setRollbackOnlyされたトランザクションは最終的にはロールバックされます。static voidwith(Propagation propagation, java.util.function.Consumer<Transaction> func)指定のpropagationで、トランザクションを起動しfuncを実行します。static <R> Rwith(Propagation propagation, java.util.function.Function<Transaction,R> func)指定のpropagationで、トランザクションを起動しfuncを実行します。static voidwith(TransactionOption option, java.util.function.Consumer<Transaction> func)指定のoptionで、トランザクションを起動しfuncを実行します。static <R> Rwith(TransactionOption option, java.util.function.Function<Transaction,R> func)指定のoptionで、トランザクションを起動しfuncを実行します。
-
Field Details
-
NO_TRANSACTION
トランザクションがない状態を表すTransactionのインスタンスです。 トランザクションがまだ開始されていない状態、もしくはトランザクションがサスペンドされている場合に当インスタンスが返却されます。
getStatus()は常にTransactionStatus.NONEを返します。
setAttribute(Object, Object)などのその他のトランザクション制御メソッドはなにも処理しません。
-
-
Method Details
-
getCurrent
現在の実行コンテキストに関連しているトランザクションのインスタンスを取得します。 もし、トランザクションが開始されていない場合は、NO_TRANSACTIONが返却されます。- Returns:
-
commit
void commit()トランザクションをコミットします。 -
rollback
void rollback()トランザクションをロールバックします。 -
setRollbackOnly
void setRollbackOnly()このトランザクションをロールバックするものとしてマークします。 setRollbackOnlyされたトランザクションは最終的にはロールバックされます。 -
isRollbackOnly
boolean isRollbackOnly()このトランザクションがsetRollbackOnlyされているかどうかを取得します。- Returns:
- setRollbackOnlyの場合true
-
isReadOnly
boolean isReadOnly()このトランザクションがReadOnlyとしてマークされているかどうかを取得します。- Returns:
-
getStatus
TransactionStatus getStatus()トランザクションの状態を取得します。- Returns:
-
setAttribute
void setAttribute(java.lang.Object key, java.lang.Object value)このトランザクションのコンテキストに特定の属性を紐づけます。- Parameters:
key- 属性のキーvalue- 属性の値
-
getAttribute
java.lang.Object getAttribute(java.lang.Object key)このトランザクションコンテキストに紐づけられている特定の属性を取得します。 同一トランザクション内でsetAttribute()したものがあれば、その値が取得できます。- Parameters:
key- 属性のキー- Returns:
- 属性の値
-
removeAttribute
java.lang.Object removeAttribute(java.lang.Object key)このトランザクションコンテキストに紐づけられている特定の属性を削除します。- Parameters:
key- 属性のキー- Returns:
- 削除された値
-
addTransactionListener
このトランザクションのcommit、rollbackを監視するリスナーを登録します。- Parameters:
listener-
-
afterCommit
default void afterCommit(java.lang.Runnable func)このトランザクションがcommitされた場合、funcを実行します。 funcの引数にはこのトランザクションが渡されます。- Parameters:
func-
-
afterRollback
default void afterRollback(java.lang.Runnable func)このトランザクションがrollbackされた場合、funcを実行します。 funcの引数にはこのトランザクションが渡されます。- Parameters:
func-
-
required
トランザクションが開始していない場合はトランザクションを起動し、funcを実行します。 トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。- Parameters:
func-
-
required
トランザクションが開始していない場合はトランザクションを起動し、funcを実行します。 トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。- Parameters:
func-- Returns:
- funcが返却する値
-
requiresNew
新規にトランザクションを起動し、funcを実行します。 トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。- Parameters:
func-
-
requiresNew
新規にトランザクションを起動し、funcを実行します。 トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。- Parameters:
func-- Returns:
- funcが返却する値
-
readOnly
トランザクションをreadOnlyモードで起動します。 ただし、すでにトランザクションが開始されている場合、 新規にトランザクションは開始せず既存のトランザクションをそのまま利用します。 これは、
TransactionOption.propagation=REQUIRED
TransactionOption.readOnly=true
でトランザクションを起動することを示します。- Parameters:
func-
-
readOnly
トランザクションをreadOnlyモードで起動します。 ただし、すでにトランザクションが開始されている場合、 新規にトランザクションは開始せず既存のトランザクションをそのまま利用します。 これは、
TransactionOption.propagation=REQUIRED
TransactionOption.readOnly=true
でトランザクションを起動することを示します。- Parameters:
func-- Returns:
- funcが返却する値
-
with
指定のpropagationで、トランザクションを起動しfuncを実行します。- Parameters:
propagation-func-
-
with
指定のpropagationで、トランザクションを起動しfuncを実行します。- Parameters:
propagation-func-- Returns:
- funcが返却する値
-
with
指定のoptionで、トランザクションを起動しfuncを実行します。- Parameters:
option-func-
-
with
指定のoptionで、トランザクションを起動しfuncを実行します。- Parameters:
option-func-- Returns:
- funcが返却する値
-