public class JpaTransactionManager extends AbstractPlatformTransactionManager implements ResourceTransactionManager, BeanFactoryAware, InitializingBean
EntityManagerFactory
EE の PlatformTransactionManager
実装。指定されたファクトリから JPA EntityManager をスレッドにバインドし、潜在的にファクトリごとに 1 つのスレッドにバインドされた EntityManager を許可します。SharedEntityManagerCreator
および @PersistenceContext
は、スレッドにバインドされたエンティティマネージャーを認識し、そのようなトランザクションに自動的に参加します。このトランザクション管理メカニズムをサポートする JPA アクセスコードには、どちらかを使用する必要があります。 このトランザクションマネージャーは、トランザクションデータアクセスに単一の JPA EntityManagerFactory を使用するアプリケーションに適しています。JTA(通常は JtaTransactionManager
を使用)は、同じトランザクション内の複数のトランザクションリソースにアクセスするために必要です。JTA トランザクションに参加させるには、JPA プロバイダーを適宜構成する必要があることに注意してください。
このトランザクションマネージャーは、トランザクション内での直接 DataSource アクセスもサポートします(つまり、同じ DataSource で動作するプレーンな JDBC コード)。これにより、JPA にアクセスするサービスとプレーンな JDBC を使用するサービスを(JPA を意識せずに)混在させることができます! アプリケーションコードは、DataSourceTransactionManager
と同じ単純な接続ルックアップパターン(つまり、DataSourceUtils.getConnection(javax.sql.DataSource)
または TransactionAwareDataSourceProxy
を経由する)に固執する必要があります。これには、ベンダー固有の JpaDialect
を構成する必要があることに注意してください。
メモ: プレーンな JDBC コードに DataSource の接続を登録するには、このインスタンスが DataSource (setDataSource(javax.sql.DataSource)
) を認識する必要があります。指定された DataSource は、指定された EntityManagerFactory で使用されるものと明らかに一致する必要があります。このトランザクションマネージャーは、EntityManagerFactory の接続ファクトリとして使用される DataSource を自動検出するため、通常は "dataSource" プロパティを明示的に指定する必要はありません。
このトランザクションマネージャーは、JDBC 3.0 セーブポイントを介したネストされたトランザクションをサポートします。ただし、ネストされたトランザクションは JPA EntityManager とそのキャッシュされたエンティティオブジェクトおよび関連コンテキストではなく JDBC 接続にのみ適用されるため、"nestedTransactionAllowed"
フラグのデフォルトは false
です。JPA トランザクションに参加する JDBC アクセスコードにネストされたトランザクションを使用する場合は、手動でフラグを true
に設定できます(JDBC ドライバーがセーブポイントをサポートしている場合)。JPA 自体はネストされたトランザクションをサポートしないことに注意してください! したがって、JPA アクセスコードが意味的にネストされたトランザクションに参加することを期待しないでください。
setEntityManagerFactory(javax.persistence.EntityManagerFactory)
, setDataSource(javax.sql.DataSource)
, LocalEntityManagerFactoryBean
, SharedEntityManagerBean
, DataSourceUtils.getConnection(javax.sql.DataSource)
, DataSourceUtils.releaseConnection(java.sql.Connection, javax.sql.DataSource)
, JdbcTemplate
, DataSourceTransactionManager
, JtaTransactionManager
, 直列化された形式 logger, SYNCHRONIZATION_ALWAYS, SYNCHRONIZATION_NEVER, SYNCHRONIZATION_ON_ACTUAL_TRANSACTION
コンストラクターと説明 |
---|
JpaTransactionManager() 新しい JpaTransactionManager インスタンスを作成します。 |
JpaTransactionManager(EntityManagerFactoryEE emf) 新しい JpaTransactionManager インスタンスを作成します。 |
修飾子と型 | メソッドと説明 |
---|---|
void | afterPropertiesSet() JPA ダイアレクトを積極的に初期化し、設定されていない場合は、指定された EntityManagerFactory のデフォルトのダイアレクトを作成します。 |
protected void | closeEntityManagerAfterFailedBegin(org.springframework.orm.jpa.JpaTransactionManager.JpaTransactionObject txObject) 現在のトランザクションの EntityManager を閉じます。 |
protected EntityManagerEE | createEntityManagerForTransaction() トランザクションに使用される JPA EntityManager を作成します。 |
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 を返します。 |
EntityManagerFactoryEE | getEntityManagerFactory() このインスタンスがトランザクションを管理する EntityManagerFactory を返します。 |
JpaDialect | getJpaDialect() このトランザクションマネージャーに使用する JPA ダイアレクトを返します。 |
MapSE<StringSE, ObjectSE> | getJpaPropertyMap() 特定のエントリを追加または上書きするオプションを使用して、JPA プロパティへのマップアクセスを永続性プロバイダーに渡すことができます。 |
StringSE | getPersistenceUnitName() 存在する場合、トランザクションを管理する永続性ユニットの名前を返します。 |
ObjectSE | getResourceFactory() このトランザクションマネージャーが動作するリソースファクトリを返します。 |
protected boolean | isExistingTransaction(ObjectSE transaction) 指定されたトランザクションオブジェクトが既存のトランザクション(つまり、すでに開始されているトランザクション)を示しているかどうかを確認します。 |
protected EntityManagerFactoryEE | obtainEntityManagerFactory() 実際に使用するために EntityManagerFactory を取得します。 |
void | setBeanFactory(BeanFactory beanFactory) 明示的に設定されていない場合は、永続ユニット名で EntityManagerFactory を取得します。 |
void | setDataSource(DataSourceSE dataSource) このインスタンスがトランザクションを管理する JDBC DataSource を設定します。 |
void | setEntityManagerFactory(EntityManagerFactoryEE emf) このインスタンスがトランザクションを管理する EntityManagerFactory を設定します。 |
void | setJpaDialect(JpaDialect jpaDialect) このトランザクションマネージャーに使用する JPA ダイアレクトを設定します。 |
void | setJpaProperties(PropertiesSE jpaProperties) EntityManagerFactory.createEntityManager(Map) (存在する場合)に渡される JPA プロパティを指定します。 |
void | setJpaPropertyMap(MapSE<StringSE,?> jpaProperties) JPA プロパティをマップとして指定し、 EntityManagerFactory.createEntityManager(Map) (存在する場合)に渡されます。 |
void | setPersistenceUnitName(StringSE persistenceUnitName) トランザクションを管理する永続性ユニットの名前を設定します。 |
protected boolean | shouldCommitOnGlobalRollbackOnly() この実装は "true" を返します: JPA コミットは、グローバルレベルでロールバック専用としてマークされたトランザクションを適切に処理します。 |
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, suspend, triggerBeforeCommit, triggerBeforeCompletion, useSavepointForNestedTransaction
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
commit, getTransaction, rollback
public JpaTransactionManager()
EntityManagerFactory を使用できるように設定する必要があります。
public JpaTransactionManager(EntityManagerFactoryEE emf)
emf
- トランザクションを管理する EntityManagerFactorypublic void setEntityManagerFactory(@Nullable EntityManagerFactoryEE emf)
または、ターゲット EntityManagerFactory の永続性ユニット名を指定します。デフォルトでは、包含 BeanFactory で型 EntityManagerFactory の単一の固有 Bean を見つけることにより、デフォルト EntityManagerFactory が取得されます。
@Nullable public EntityManagerFactoryEE getEntityManagerFactory()
protected final EntityManagerFactoryEE obtainEntityManagerFactory()
null
)IllegalStateExceptionSE
- EntityManagerFactory セットがない場合 public void setPersistenceUnitName(@Nullable StringSE persistenceUnitName)
これは、直接参照によって EntityManagerFactory を指定する代わりに、代わりに永続化ユニット名で解決します。EntityManagerFactory および永続性ユニット名が指定されていない場合、型 EntityManagerFactory の単一の固有 Bean を見つけることにより、デフォルト EntityManagerFactory が取得されます。
@Nullable public StringSE getPersistenceUnitName()
public void setJpaProperties(@Nullable PropertiesSE jpaProperties)
EntityManagerFactory.createEntityManager(Map)
(存在する場合)に渡される JPA プロパティを指定します。文字列 "value" (PropertiesEditor で解析)または XML Bean 定義の "props" 要素を入力できます。
public void setJpaPropertyMap(@Nullable MapSE<StringSE,?> jpaProperties)
EntityManagerFactory.createEntityManager(Map)
(存在する場合)に渡されます。XML Bean 定義の「マップ」または "props" 要素を取り込むことができます。
public MapSE<StringSE,ObjectSE> getJpaPropertyMap()
"jpaPropertyMap [myKey]" などを介して、エントリを直接指定するのに便利です。
public void setDataSource(@Nullable DataSourceSE dataSource)
EntityManagerFactory が接続ファクトリとして既知の DataSource を使用する場合、DataSource は自動検出されます。DataSource を明示的に指定することはできますが、この場合は必要ありません。
この DataSource のトランザクション JDBC 接続は、DataSourceUtils または JdbcTemplate を介してこの DataSource に直接アクセスするアプリケーションコードに提供されます。接続は、JPA EntityManager から取得されます。
JPA トランザクションを JDBC トランザクションとして公開できるようにするには、特定の JPA 実装に JPA ダイアレクトを使用する必要があることに注意してください。
ここで指定する DataSource は、TransactionAwareDataSourceProxy ではなく、トランザクションを管理するターゲット DataSource である必要があります。データアクセスコードのみが TransactionAwareDataSourceProxy で機能しますが、トランザクションマネージャーは基になるターゲット DataSource で機能する必要があります。それでも TransactionAwareDataSourceProxy が渡された場合、ターゲット DataSource を抽出するためにラップ解除されます。
@Nullable public DataSourceSE getDataSource()
public void setJpaDialect(@Nullable JpaDialect jpaDialect)
EntityManagerFactory が既知の JpaDialect を使用している場合、自動検出されます。DataSource を明示的に指定することはできますが、この場合は必要ありません。
ダイアレクトオブジェクトを使用して、基礎となる JDBC 接続を取得することができます。JPA トランザクションを JDBC トランザクションとして公開できます。
public JpaDialect getJpaDialect()
public void setBeanFactory(BeanFactory beanFactory) throws BeansException
BeanFactoryAware
の setBeanFactory
beanFactory
- 所有 BeanFactory(非 null
)。Bean は、ファクトリのメソッドをすぐに呼び出すことができます。BeansException
- 初期化エラーの場合 setPersistenceUnitName(java.lang.String)
public void afterPropertiesSet()
InitializingBean
の afterPropertiesSet
public ObjectSE getResourceFactory()
ResourceTransactionManager
このターゲットリソースファクトリは、通常、スレッドごとの TransactionSynchronizationManager
のリソースバインディングのリソースキーとして使用されます。
ResourceTransactionManager
の getResourceFactory
null
)TransactionSynchronizationManager.bindResource(java.lang.Object, java.lang.Object)
, TransactionSynchronizationManager.getResource(java.lang.Object)
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()
protected boolean isExistingTransaction(ObjectSE transaction)
AbstractPlatformTransactionManager
結果は、新しいトランザクションに対して指定された伝播動作に従って評価されます。既存のトランザクションが中断される(PROPAGATION_REQUIRES_NEW の場合)か、新しいトランザクションが既存のトランザクションに参加する可能性があります(PROPAGATION_REQUIRED の場合)。
デフォルト実装は false
を返しますが、既存のトランザクションへの参加は一般にサポートされていないと想定しています。もちろん、サブクラスはそのようなサポートを提供することをお勧めします。
AbstractPlatformTransactionManager
の isExistingTransaction
transaction
- doGetTransaction によって返されるトランザクションオブジェクト AbstractPlatformTransactionManager.doGetTransaction()
protected void doBegin(ObjectSE transaction, TransactionDefinition definition)
AbstractPlatformTransactionManager
このメソッドは、トランザクションマネージャーが実際に新しいトランザクションを開始することを決定したときに呼び出されます。以前にトランザクションがなかったか、前のトランザクションが中断されています。
特別なシナリオは、セーブポイントのないネストされたトランザクションです: useSavepointForNestedTransaction()
が "false" を返す場合、このメソッドは、必要に応じてネストされたトランザクションを開始するために呼び出されます。このようなコンテキストでは、アクティブなトランザクションがあります。このメソッドの実装はこれを検出し、適切なネストされたトランザクションを開始する必要があります。
AbstractPlatformTransactionManager
の doBegin
transaction
- doGetTransaction
によって返されたトランザクションオブジェクト definition
- 伝播動作、分離レベル、読み取り専用フラグ、タイムアウト、トランザクション名を記述する TransactionDefinition インスタンス protected EntityManagerEE createEntityManagerForTransaction()
デフォルトの実装では、EntityManagerFactory が Spring プロキシであるかどうかを確認し、最初に展開します。
protected void closeEntityManagerAfterFailedBegin(org.springframework.orm.jpa.JpaTransactionManager.JpaTransactionObject txObject)
txObject
- 現在のトランザクション protected ObjectSE doSuspend(ObjectSE transaction)
AbstractPlatformTransactionManager
トランザクションの一時停止が一般的にサポートされていないと仮定すると、デフォルトの実装は TransactionSuspensionNotSupportedException をスローします。
AbstractPlatformTransactionManager
の doSuspend
transaction
- doGetTransaction
によって返されたトランザクションオブジェクト AbstractPlatformTransactionManager.doResume(java.lang.Object, java.lang.Object)
protected void doResume(@Nullable ObjectSE transaction, ObjectSE suspendedResources)
AbstractPlatformTransactionManager
トランザクションの一時停止が一般的にサポートされていないと仮定すると、デフォルトの実装は TransactionSuspensionNotSupportedException をスローします。
AbstractPlatformTransactionManager
の doResume
transaction
- doGetTransaction
によって返されたトランザクションオブジェクト suspendedResources
- doSuspend によって返される、中断されたリソースを保持するオブジェクト AbstractPlatformTransactionManager.doSuspend(java.lang.Object)
protected boolean shouldCommitOnGlobalRollbackOnly()
AbstractPlatformTransactionManager
の shouldCommitOnGlobalRollbackOnly
AbstractPlatformTransactionManager.doCommit(org.springframework.transaction.support.DefaultTransactionStatus)
, DefaultTransactionStatus.isGlobalRollbackOnly()
, AbstractTransactionStatus.isLocalRollbackOnly()
, TransactionStatus.setRollbackOnly()
, UnexpectedRollbackException
, UserTransaction.commit()
SE, RollbackException
SEprotected void doCommit(DefaultTransactionStatus status)
AbstractPlatformTransactionManager
実装では、「新規トランザクション」フラグまたはロールバック専用フラグを確認する必要はありません。これはすでに以前に処理されています。通常、渡されたステータスに含まれるトランザクションオブジェクトに対してストレートコミットが実行されます。
AbstractPlatformTransactionManager
の doCommit
status
- トランザクションのステータス表現 DefaultTransactionStatus.getTransaction()
protected void doRollback(DefaultTransactionStatus status)
AbstractPlatformTransactionManager
実装では、「新しいトランザクション」フラグを確認する必要はありません。これはすでに以前に処理されています。通常、渡されたステータスに含まれるトランザクションオブジェクトに対してストレートロールバックが実行されます。
AbstractPlatformTransactionManager
の doRollback
status
- トランザクションのステータス表現 DefaultTransactionStatus.getTransaction()
protected void doSetRollbackOnly(DefaultTransactionStatus status)
AbstractPlatformTransactionManager
既存のトランザクションへの参加は一般にサポートされていないと想定して、デフォルトの実装は IllegalTransactionStateException をスローします。もちろん、サブクラスはそのようなサポートを提供することをお勧めします。
AbstractPlatformTransactionManager
の doSetRollbackOnly
status
- トランザクションのステータス表現 protected void doCleanupAfterCompletion(ObjectSE transaction)
AbstractPlatformTransactionManager
doCommit
および doRollback
の実行後に、結果について呼び出されます。デフォルトの実装は何もしません。
例外をスローするべきではなく、エラーに対して警告を発行するだけです。
AbstractPlatformTransactionManager
の doCleanupAfterCompletion
transaction
- doGetTransaction
によって返されたトランザクションオブジェクト