DataSourceTransactionManager (Spring Framework 5.2.6.RELEASE API)

java.lang.ObjectSE
- org.springframework.transaction.support.AbstractPlatformTransactionManager
- - org.springframework.jdbc.datasource.DataSourceTransactionManager

実装されているすべてのインターフェース:
SerializableSE, InitializingBean, PlatformTransactionManager, ResourceTransactionManager, TransactionManager
```
public class DataSourceTransactionManager
extends AbstractPlatformTransactionManager
implements ResourceTransactionManager, InitializingBean
```
単一の JDBC DataSourceSE の PlatformTransactionManager 実装。このクラスは、セットアップが Connection ファクトリメカニズムとして javax.sql.DataSource を使用している限り、任意の JDBC ドライバーを備えた任意の環境で動作できます。指定された DataSource から現在のスレッドに JDBC 接続をバインドし、潜在的に DataSource ごとに 1 つのスレッドバインド接続を許可します。
注: このトランザクションマネージャーが操作する DataSource は、独立した Connections を返す必要があります。接続はプールから取得できます（通常の場合）が、DataSource はスレッドスコープ / リクエストスコープの接続などを返すことはできません。このトランザクションマネージャーは、指定された伝播動作に従って、Connections をスレッドバインドトランザクション自体に関連付けます。進行中のトランザクション中でも、独立した独立した接続を取得できると想定しています。
標準の Java EE スタイルの DataSource.getConnection()SE 呼び出しではなく、DataSourceUtils.getConnection(DataSource) を介して JDBC 接続を取得するには、アプリケーションコードが必要です。JdbcTemplate などの Spring クラスは、この戦略を暗黙的に使用します。このトランザクションマネージャーと組み合わせて使用しない場合、DataSourceUtils ルックアップ戦略はネイティブ DataSource ルックアップとまったく同じように動作します。ポータブルな方法で使用できます。
または、Spring をまったく認識しないレガシーコードなど、アプリケーションコードが標準の Java EE スタイルのルックアップパターン DataSource.getConnection()SE で動作することを許可できます。その場合、ターゲット DataSource の TransactionAwareDataSourceProxy を定義し、そのプロキシ DataSource を DAO に渡します。DAO は、アクセス時に Spring 管理のトランザクションに自動的に参加します。
カスタム分離レベル、および適切な JDBC ステートメントタイムアウトとして適用されるタイムアウトをサポートします。後者をサポートするには、アプリケーションコードは JdbcTemplate を使用するか、作成された JDBC ステートメントごとに DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource) を呼び出すか、タイムアウト対応の JDBC 接続とステートメントを自動的に作成する TransactionAwareDataSourceProxy を実行する必要があります。
ターゲット DataSource の LazyConnectionDataSourceProxy を定義し、このトランザクションマネージャーと DAO の両方を指すようにすることを検討してください。これにより、「空の」トランザクション、つまり JDBC ステートメントが実行されていないトランザクションの処理が最適化されます。LazyConnectionDataSourceProxy は、Statement が実行されるまでターゲット DataSource から実際の JDBC 接続をフェッチせず、指定されたトランザクション設定をターゲット接続に遅延的に適用します。
このトランザクションマネージャーは、JDBC 3.0 SavepointSE メカニズムを介してネストされたトランザクションをサポートします。ネストされたトランザクションは、セーブポイントをサポートする JDBC ドライバー（Oracle JDBC ドライバーなど）に制限なく機能するため、"nestedTransactionAllowed" フラグのデフォルトは "true" です。
このトランザクションマネージャーは、JTA をサポートするコンテナーを必要としないため、単一リソースの場合に JtaTransactionManager の代わりとして使用できます。通常は、ローカルで定義された JDBC DataSource (Apache Commons DBCP 接続プールなど) と組み合わせて使用します。このローカル戦略と JTA 環境を切り替えるのは、構成の問題だけです。
4.3.4 の時点で、このトランザクションマネージャーは、基になる JDBC Connection で動作するリソースを想定して、登録されたトランザクション同期でフラッシュコールバックをトリガーします（同期が一般的にアクティブな場合）。これにより、特に遅延登録された ORM リソース（例: Hibernate Session）に関して、JtaTransactionManager に類似したセットアップが可能になります。
導入:
02.05.2003
作成者:
Juergen Hoeller
関連事項:
AbstractPlatformTransactionManager.setNestedTransactionAllowed(boolean), SavepointSE, DataSourceUtils.getConnection(javax.sql.DataSource), DataSourceUtils.applyTransactionTimeout(java.sql.Statement, javax.sql.DataSource), DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource), TransactionAwareDataSourceProxy, LazyConnectionDataSourceProxy, JdbcTemplate, 連載形式

ネストされたクラスの要約
- クラス org.springframework.transaction.support.AbstractPlatformTransactionManager から継承されたネストクラス / インターフェース
  AbstractPlatformTransactionManager.SuspendedResourcesHolder

フィールドのサマリー
- クラス org.springframework.transaction.support.AbstractPlatformTransactionManager から継承されたフィールド
  logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION

コンストラクターの概要

コンストラクター
コンストラクターと説明
`DataSourceTransactionManager()` 新しい DataSourceTransactionManager インスタンスを作成します。
`DataSourceTransactionManager(DataSourceSE dataSource)` 新しい DataSourceTransactionManager インスタンスを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` すべての Bean プロパティを設定し、`BeanFactoryAware`、`ApplicationContextAware` などを満たした後、包含 `BeanFactory` によって呼び出されます。
`protected void`	`doBegin(ObjectSE transaction, TransactionDefinition definition)` この実装は分離レベルを設定しますが、タイムアウトは無視します。
`protected void`	`doCleanupAfterCompletion(ObjectSE transaction)` トランザクション完了後にリソースをクリーンアップします。
`protected void`	`doCommit(DefaultTransactionStatus status)` 指定されたトランザクションの実際のコミットを実行します。
`protected ObjectSE`	`doGetTransaction()` 現在のトランザクション状態のトランザクションオブジェクトを返します。
`protected void`	`doResume(ObjectSE transaction, ObjectSE suspendedResources)` 現在のトランザクションのリソースを再開します。
`protected void`	`doRollback(DefaultTransactionStatus status)` 指定されたトランザクションの実際のロールバックを実行します。
`protected void`	`doSetRollbackOnly(DefaultTransactionStatus status)` 指定されたトランザクションをロールバックのみに設定します。
`protected ObjectSE`	`doSuspend(ObjectSE transaction)` 現在のトランザクションのリソースを一時停止します。
`DataSourceSE`	`getDataSource()` このインスタンスがトランザクションを管理する JDBC DataSource を返します。
`ObjectSE`	`getResourceFactory()` このトランザクションマネージャーが動作するリソースファクトリを返します。
`boolean`	`isEnforceReadOnly()` トランザクション接続で明示的なステートメントを使用して、トランザクションの読み取り専用の性質を強制するかどうかを返します。
`protected boolean`	`isExistingTransaction(ObjectSE transaction)` 指定されたトランザクションオブジェクトが既存のトランザクション（つまり、すでに開始されているトランザクション）を示しているかどうかを確認します。
`protected DataSourceSE`	`obtainDataSource()` 実際に使用するために DataSource を取得します。
`protected void`	`prepareTransactionalConnection(ConnectionSE con, TransactionDefinition definition)` トランザクション開始直後にトランザクション `Connection` を準備します。
`void`	`setDataSource(DataSourceSE dataSource)` このインスタンスがトランザクションを管理する JDBC DataSource を設定します。
`void`	`setEnforceReadOnly(boolean enforceReadOnly)` トランザクションの読み取り専用の性質を強制するかどうかを指定します（トランザクション接続の明示的なステートメントを通じて `TransactionDefinition.isReadOnly()` で示されるように: Oracle、MySQL、Postgres が理解できる "SET TRANSACTION READ ONLY"。

クラス org.springframework.transaction.support.AbstractPlatformTransactionManager から継承されたメソッド
commit, determineTimeout, getDefaultTimeout, getTransaction, getTransactionSynchronization, invokeAfterCompletion, isFailEarlyOnGlobalRollbackOnly, isGlobalRollbackOnParticipationFailure, isNestedTransactionAllowed, isRollbackOnCommitFailure, isValidateExistingTransaction, newTransactionStatus, prepareForCommit, prepareSynchronization, prepareTransactionStatus, registerAfterCompletionWithExistingTransaction, resume, rollback, setDefaultTimeout, setFailEarlyOnGlobalRollbackOnly, setGlobalRollbackOnParticipationFailure, setNestedTransactionAllowed, setRollbackOnCommitFailure, setTransactionSynchronization, setTransactionSynchronizationName, setValidateExistingTransaction, shouldCommitOnGlobalRollbackOnly, suspend, triggerBeforeCommit, triggerBeforeCompletion, useSavepointForNestedTransaction

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース org.springframework.transaction.PlatformTransactionManager から継承されたメソッド
commit, getTransaction, rollback

- コンストラクターの詳細
  - DataSourceTransactionManager
```
public DataSourceTransactionManager()
```
    新しい DataSourceTransactionManager インスタンスを作成します。DataSource を使用できるように設定する必要があります。
    関連事項:
    setDataSource(javax.sql.DataSource)
  - DataSourceTransactionManager
```
public DataSourceTransactionManager(DataSourceSE dataSource)
```
    新しい DataSourceTransactionManager インスタンスを作成します。
    パラメーター:
    dataSource - トランザクションを管理する JDBC DataSource
- メソッドの詳細
  - setDataSource
```
public void setDataSource(@Nullable
                          DataSourceSE dataSource)
```
    このインスタンスがトランザクションを管理する JDBC DataSource を設定します。
    これは通常、ローカルに定義された DataSource (Apache Commons DBCP 接続プールなど) になります。または、JNDI からフェッチされた非 XA J2EE DataSource のトランザクションを実行することもできます。XA DataSource の場合は、JtaTransactionManager を使用します。
    ここで指定する DataSource は、TransactionAwareDataSourceProxy ではなく、トランザクションを管理するターゲット DataSource である必要があります。データアクセスコードのみが TransactionAwareDataSourceProxy で機能しますが、トランザクションマネージャーは基になるターゲット DataSource で機能する必要があります。それでも TransactionAwareDataSourceProxy が渡された場合、ターゲット DataSource を抽出するためにラップ解除されます。
    ここで渡された DataSource は、独立した Connections を返す必要があります。接続はプールから取得できます（通常の場合）が、DataSource はスレッドスコープ / リクエストスコープの接続などを返すことはできません。
    関連事項:
    TransactionAwareDataSourceProxy, JtaTransactionManager
  - getDataSource
```
@Nullable
public DataSourceSE getDataSource()
```
    このインスタンスがトランザクションを管理する JDBC DataSource を返します。
  - obtainDataSource
```
protected DataSourceSE obtainDataSource()
```
    実際に使用するために DataSource を取得します。
    戻り値:
    DataSource (非 null)
    例外:
    IllegalStateExceptionSE - DataSource セットがない場合
    導入:
    5.0
  - setEnforceReadOnly
```
public void setEnforceReadOnly(boolean enforceReadOnly)
```
    トランザクションの読み取り専用の性質を強制するかどうかを指定します（トランザクション接続の明示的なステートメントを通じて TransactionDefinition.isReadOnly() で示されるように: Oracle、MySQL、Postgres が理解できる "SET TRANSACTION READ ONLY"。
    接続で実行される SQL ステートメントを含む正確な処理は、prepareTransactionalConnection(java.sql.Connection, org.springframework.transaction.TransactionDefinition) を使用してカスタマイズできます。
    この読み取り専用処理モードは、Spring がデフォルトで適用する Connection.setReadOnly(boolean)SE ヒントを超えています。その標準 JDBC ヒントとは対照的に、"SET TRANSACTION READ ONLY" は、データ操作ステートメントが厳密に許可されない分離レベルのような接続モードを強制します。また、Oracle では、この読み取り専用モードはトランザクション全体の読み取り一貫性を提供します。
    古い Oracle JDBC ドライバ (9i, 10g) では、Connection.setReadOnly(true でもこの読み取り専用モードが強制されていました。ただし、最近のドライバでは、この強力な強制は、このフラグなどで明示的に適用する必要があります。
    導入:
    4.3.7
    関連事項:
    prepareTransactionalConnection(java.sql.Connection, org.springframework.transaction.TransactionDefinition)
  - isEnforceReadOnly
```
public boolean isEnforceReadOnly()
```
    トランザクション接続で明示的なステートメントを使用して、トランザクションの読み取り専用の性質を強制するかどうかを返します。
    導入:
    4.3.7
    関連事項:
    setEnforceReadOnly(boolean)
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    インターフェースからコピーされた説明: InitializingBean
    すべての Bean プロパティを設定し、BeanFactoryAware、ApplicationContextAware などを満たした後、包含 BeanFactory によって呼び出されます。
    このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。
    次で指定:
    インターフェース InitializingBean の afterPropertiesSet
  - getResourceFactory
```
public ObjectSE getResourceFactory()
```
    インターフェースからコピーされた説明: ResourceTransactionManager
    このトランザクションマネージャーが動作するリソースファクトリを返します。JDBC DataSource または JMS ConnectionFactory。
    このターゲットリソースファクトリは、通常、スレッドごとの TransactionSynchronizationManager のリソースバインディングのリソースキーとして使用されます。
    次で指定:
    インターフェース ResourceTransactionManager の getResourceFactory
    戻り値:
    ターゲットリソースファクトリ (非 null)
    関連事項:
    TransactionSynchronizationManager.bindResource(java.lang.Object, java.lang.Object), TransactionSynchronizationManager.getResource(java.lang.Object)
  - doGetTransaction
```
protected ObjectSE doGetTransaction()
```
    クラスからコピーされた説明: AbstractPlatformTransactionManager
    現在のトランザクション状態のトランザクションオブジェクトを返します。
    返されるオブジェクトは通常、具体的なトランザクションマネージャーの実装に固有のものであり、対応するトランザクション状態を変更可能な形式で保持します。このオブジェクトは、他のテンプレートメソッド (doBegin や doCommit など) に直接、または DefaultTransactionStatus インスタンスの一部として渡されます。
    返されるオブジェクトには、既存のトランザクション、つまり、トランザクションマネージャーでの現在の getTransaction 呼び出しの前にすでに開始されているトランザクションに関する情報が含まれている必要があります。その結果、doGetTransaction 実装は通常、既存のトランザクションを探し、返されたトランザクションオブジェクトに対応する状態を格納します。
    次で指定:
    クラス AbstractPlatformTransactionManager の doGetTransaction
    戻り値:
    現在のトランザクションオブジェクト
    関連事項:
    AbstractPlatformTransactionManager.doBegin(java.lang.Object, org.springframework.transaction.TransactionDefinition), AbstractPlatformTransactionManager.doCommit(org.springframework.transaction.support.DefaultTransactionStatus), AbstractPlatformTransactionManager.doRollback(org.springframework.transaction.support.DefaultTransactionStatus), DefaultTransactionStatus.getTransaction()
  - isExistingTransaction
```
protected boolean isExistingTransaction(ObjectSE transaction)
```
    クラスからコピーされた説明: AbstractPlatformTransactionManager
    指定されたトランザクションオブジェクトが既存のトランザクション（つまり、すでに開始されているトランザクション）を示しているかどうかを確認します。
    結果は、新しいトランザクションに対して指定された伝播動作に従って評価されます。既存のトランザクションが中断される（PROPAGATION_REQUIRES_NEW の場合）か、新しいトランザクションが既存のトランザクションに参加する可能性があります（PROPAGATION_REQUIRED の場合）。
    デフォルト実装は false を返しますが、既存のトランザクションへの参加は一般にサポートされていないと想定しています。もちろん、サブクラスはそのようなサポートを提供することをお勧めします。
    オーバーライド:
    クラス AbstractPlatformTransactionManager の isExistingTransaction
    パラメーター:
    transaction - doGetTransaction によって返されるトランザクションオブジェクト
    戻り値:
    既存のトランザクションがある場合
    関連事項:
    AbstractPlatformTransactionManager.doGetTransaction()
  - doBegin
```
protected void doBegin(ObjectSE transaction,
                       TransactionDefinition definition)
```
    この実装は分離レベルを設定しますが、タイムアウトは無視します。
    次で指定:
    クラス AbstractPlatformTransactionManager の doBegin
    パラメーター:
    transaction - doGetTransaction によって返されるトランザクションオブジェクト
    definition - 伝播動作、分離レベル、読み取り専用フラグ、タイムアウト、トランザクション名を記述する TransactionDefinition インスタンス
  - doSuspend
```
protected ObjectSE doSuspend(ObjectSE transaction)
```
    クラスからコピーされた説明: AbstractPlatformTransactionManager
    現在のトランザクションのリソースを一時停止します。トランザクションの同期はすでに中断されています。
    トランザクションの一時停止が一般的にサポートされていないと仮定すると、デフォルトの実装は TransactionSuspensionNotSupportedException をスローします。
    オーバーライド:
    クラス AbstractPlatformTransactionManager の doSuspend
    パラメーター:
    transaction - doGetTransaction によって返されるトランザクションオブジェクト
    戻り値:
    中断されたリソースを保持するオブジェクト (doResume に渡すために検査されないままになります)
    関連事項:
    AbstractPlatformTransactionManager.doResume(java.lang.Object, java.lang.Object)
  - doResume
```
protected void doResume(@Nullable
                        ObjectSE transaction,
                        ObjectSE suspendedResources)
```
    クラスからコピーされた説明: AbstractPlatformTransactionManager
    現在のトランザクションのリソースを再開します。トランザクションの同期はその後再開されます。
    トランザクションの一時停止が一般的にサポートされていないと仮定すると、デフォルトの実装は TransactionSuspensionNotSupportedException をスローします。
    オーバーライド:
    クラス AbstractPlatformTransactionManager の doResume
    パラメーター:
    transaction - doGetTransaction によって返されるトランザクションオブジェクト
    suspendedResources - doSuspend によって返される、中断されたリソースを保持するオブジェクト
    関連事項:
    AbstractPlatformTransactionManager.doSuspend(java.lang.Object)
  - doCommit
```
protected void doCommit(DefaultTransactionStatus status)
```
    クラスからコピーされた説明: AbstractPlatformTransactionManager
    指定されたトランザクションの実際のコミットを実行します。
    実装では、「新規トランザクション」フラグまたはロールバック専用フラグを確認する必要はありません。これはすでに以前に処理されています。通常、渡されたステータスに含まれるトランザクションオブジェクトに対してストレートコミットが実行されます。
    次で指定:
    クラス AbstractPlatformTransactionManager の doCommit
    パラメーター:
    status - トランザクションのステータス表現
    関連事項:
    DefaultTransactionStatus.getTransaction()
  - doRollback
```
protected void doRollback(DefaultTransactionStatus status)
```
    クラスからコピーされた説明: AbstractPlatformTransactionManager
    指定されたトランザクションの実際のロールバックを実行します。
    実装では、「新しいトランザクション」フラグを確認する必要はありません。これはすでに以前に処理されています。通常、渡されたステータスに含まれるトランザクションオブジェクトに対してストレートロールバックが実行されます。
    次で指定:
    クラス AbstractPlatformTransactionManager の doRollback
    パラメーター:
    status - トランザクションのステータス表現
    関連事項:
    DefaultTransactionStatus.getTransaction()
  - doSetRollbackOnly
```
protected void doSetRollbackOnly(DefaultTransactionStatus status)
```
    クラスからコピーされた説明: AbstractPlatformTransactionManager
    指定されたトランザクションをロールバックのみに設定します。現在のトランザクションが既存のトランザクションに参加している場合にのみ、ロールバック時に呼び出されます。
    既存のトランザクションへの参加は一般にサポートされていないと想定して、デフォルトの実装は IllegalTransactionStateException をスローします。もちろん、サブクラスはそのようなサポートを提供することをお勧めします。
    オーバーライド:
    クラス AbstractPlatformTransactionManager の doSetRollbackOnly
    パラメーター:
    status - トランザクションのステータス表現
  - doCleanupAfterCompletion
```
protected void doCleanupAfterCompletion(ObjectSE transaction)
```
    クラスからコピーされた説明: AbstractPlatformTransactionManager
    トランザクション完了後にリソースをクリーンアップします。
    doCommit および doRollback の実行後に、結果について呼び出されます。デフォルトの実装は何もしません。
    例外をスローするべきではなく、エラーに対して警告を発行するだけです。
    オーバーライド:
    クラス AbstractPlatformTransactionManager の doCleanupAfterCompletion
    パラメーター:
    transaction - doGetTransaction によって返されるトランザクションオブジェクト
  - prepareTransactionalConnection
```
protected void prepareTransactionalConnection(ConnectionSE con,
                                              TransactionDefinition definition)
                                       throws SQLExceptionSE
```
    トランザクション開始直後にトランザクション Connection を準備します。
    "enforceReadOnly" フラグが true に設定され、トランザクション定義が読み取り専用トランザクションを示している場合、デフォルトの実装は "SET TRANSACTION READ ONLY" ステートメントを実行します。
    "SET TRANSACTION READ ONLY" は Oracle、MySQL、Postgres によって理解され、他のデータベースでも機能する場合があります。この処理を適用する場合は、それに応じてこのメソッドをオーバーライドします。
    パラメーター:
    con - トランザクション JDBC 接続
    definition - 現在のトランザクション定義
    例外:
    SQLExceptionSE - JDBC API によってスローされた場合
    導入:
    4.3.7
    関連事項:
    setEnforceReadOnly(boolean)

クラス DataSourceTransactionManager

ネストされたクラスの要約

クラス org.springframework.transaction.support.AbstractPlatformTransactionManager から継承されたネストクラス / インターフェース

フィールドのサマリー

クラス org.springframework.transaction.support.AbstractPlatformTransactionManager から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.transaction.support.AbstractPlatformTransactionManager から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.transaction.PlatformTransactionManager から継承されたメソッド

コンストラクターの詳細

DataSourceTransactionManager

DataSourceTransactionManager

メソッドの詳細

setDataSource

getDataSource

obtainDataSource

setEnforceReadOnly

isEnforceReadOnly

afterPropertiesSet

getResourceFactory

doGetTransaction

isExistingTransaction

doBegin

doSuspend

doResume

doCommit

doRollback

doSetRollbackOnly

doCleanupAfterCompletion

prepareTransactionalConnection