パッケージ jakarta.persistence

クラス PersistenceConfiguration

java.lang.ObjectSE
jakarta.persistence.PersistenceConfiguration
public class PersistenceConfiguration extends ObjectSE
永続化ユニットの構成を表し、プログラムによる EntityManagerFactory の作成を可能にします。この API 経由で利用できる構成オプションは、persistence.xml ファイルの同様の名前の要素を反映しています。

この API は、コンテナー管理の永続性ユニットの構成には使用できません。つまり、この API が Jakarta EE 環境内で使用される場合でも、構成された永続ユニットは Java SE 永続ユニットと見なされる必要があります。

EntityManagerFactory の注入が必要な場合は、CDI Producer を使用して、EntityManagerFactory を CDI 管理の Bean として利用できるようにすることができます。

同様に、EntityManager の注入が必要な場合は、CDI Producer メソッド /Disposer メソッドのペアを使用して、EntityManager を CDI 管理の Bean として利用できるようにすることができます。

永続性プロバイダーは、ベンダー固有の構成オプションを使用してこのクラスのサブクラスを定義することを目的としています。プロバイダーは、このクラスまたはこのクラスのサブクラスのインスタンスを介した構成をサポートする必要があります。

導入:
3.2
関連事項:

  • フィールドの詳細

  • コンストラクターの詳細

    • PersistenceConfiguration

      public PersistenceConfiguration(StringSE name)
      新しい空の構成を作成します。通常、空の構成には、createEntityManagerFactory() を正常に呼び出すための十分な情報が保持されていません。
      パラメーター:
      name - 永続ユニットの名前。永続プロバイダがロギングとエラー報告に使用する場合があります

  • メソッドの詳細

    • createEntityManagerFactory

      public EntityManagerFactory createEntityManagerFactory()
      この構成に基づいて新しい EntityManagerFactory を作成します。
      例外:
      PersistenceException - 必要な構成が欠落している場合、またはファクトリを作成できなかった場合

    • name

      public StringSE name()
      永続性ユニットの名前。永続性プロバイダーがログ記録やエラー報告に使用する場合があります。
      戻り値:
      永続化ユニットの名前。

    • provider

      public PersistenceConfiguration provider(StringSE providerClassName)
      永続化プロバイダーを指定します。
      パラメーター:
      providerClassName - 永続性プロバイダクラスの修飾名
      戻り値:
      この構成

    • provider

      public StringSE provider()
      PersistenceProvider を実装する具象クラスの完全修飾名。
      戻り値:
      永続性プロバイダークラスの修飾名。

    • jtaDataSource

      public PersistenceConfiguration jtaDataSource(StringSE dataSourceJndiName)
      JTA javax.sql.DataSource の JNDI 名を指定します。
      パラメーター:
      dataSourceJndiName - JTA データソースの JNDI 名
      戻り値:
      この構成

    • jtaDataSource

      public StringSE jtaDataSource()
      JTA javax.sql.DataSource の JNDI 名。
      戻り値:
      設定されている JTA データソース（存在する場合）、または null

    • nonJtaDataSource

      public PersistenceConfiguration nonJtaDataSource(StringSE dataSourceJndiName)
      非 JTA javax.sql.DataSource の JNDI 名を指定します。
      パラメーター:
      dataSourceJndiName - 非 JTA データソースの JNDI 名
      戻り値:
      この構成

    • nonJtaDataSource

      public StringSE nonJtaDataSource()
      非 JTA javax.sql.DataSource の JNDI 名。
      戻り値:
      設定されている非 JTA データソース（存在する場合）、または null

    • managedClass

      public PersistenceConfiguration managedClass(ClassSE<?> managedClass)
      マネージドクラス ( Entity、Embeddable、MappedSuperclass、または Converter ) を構成に追加します。
      パラメーター:
      managedClass - 管理クラス
      戻り値:
      この構成

    • managedClasses

      public ListSE<ClassSE<?>> managedClasses()
      構成された管理クラス、つまり Entity、Embeddable、MappedSuperclass、または Converter のアノテーションが付けられたクラスのリスト。
      戻り値:
      構成されたすべての管理クラス

    • mappingFile

      public PersistenceConfiguration mappingFile(StringSE name)
      リソースとしてロードされた XML マッピングファイルのパスを構成に追加します。
      パラメーター:
      name - マッピングファイルのリソースパス
      戻り値:
      この構成

    • mappingFiles

      public ListSE<StringSE> mappingFiles()
      XML マッピングファイルの設定されたリソースパス。
      戻り値:
      構成されたすべてのマッピングファイルリソースパス

    • transactionType

      public PersistenceConfiguration transactionType(PersistenceUnitTransactionType transactionType)
      永続化ユニットのトランザクション型を指定します。
      パラメーター:
      transactionType - 取引の種類
      戻り値:
      この構成

    • transactionType

      public PersistenceUnitTransactionType transactionType()
      トランザクションの型。
      戻り値:
      取引の種類

    • sharedCacheMode

      public PersistenceConfiguration sharedCacheMode(SharedCacheMode sharedCacheMode)
      永続化ユニットの共有キャッシュモードを指定します。
      パラメーター:
      sharedCacheMode - 共有キャッシュモード
      戻り値:
      この構成

    • sharedCacheMode

      public SharedCacheMode sharedCacheMode()
      共有キャッシュモード。デフォルトの動作は未指定で、プロバイダー固有です。
      戻り値:
      共有キャッシュモード

    • validationMode

      public PersistenceConfiguration validationMode(ValidationMode validationMode)
      永続化ユニットの検証モードを指定します。
      パラメーター:
      validationMode - 共有キャッシュモード
      戻り値:
      この構成

    • validationMode

      public ValidationMode validationMode()
      検証モード、デフォルトでは ValidationMode.AUTO。
      戻り値:
      検証モード

    • property

      public PersistenceConfiguration property(StringSE name, ObjectSE value)
      この永続化ユニットのプロパティを設定します。
      パラメーター:
      name - プロパティ名
      value - プロパティ値
      戻り値:
      この構成

    • properties

      public PersistenceConfiguration properties(MapSE<StringSE,?> properties)
      この永続ユニットの複数のプロパティを設定します。
      パラメーター:
      properties - プロパティ
      戻り値:
      この構成

    • properties

      public MapSE<StringSE,ObjectSE> properties()
      標準およびベンダー固有のプロパティ設定。
      戻り値:
      設定されたプロパティ