B Oracle WebLogic ServerでのOracle Kodoの使い方

この付録では、WebLogic ServerでのOracle Kodoアプリケーションの開発、デプロイメントおよび構成について概説します。

Kodo非推奨に関する注意:

Oracle Kodo JPA/JDOはこのリリースで非推奨になりました。JPA 2.0プロバイダのOracle TopLinkを使用することをお薦めします。Oracle TopLinkの詳細は、第8章「Oracle WebLogic Serverでの永続性プロバイダの構成」を参照してください。Kodoの非推奨化に伴い、Kodoドキュメントも非推奨になりました。WebLogic ServerでのKodoの使用方法の最新情報は、「Oracle WebLogic ServerでのOracle Kodoの使用」を参照してください。

このリリースのWebLogic ServerはサーバーのクラスパスのJPA 2.0 JARで実行されます。JPA 2.0はJPA 1.0と上位互換性がありますが、JPA 2.0では、OpenJPAインタフェース内の既存のシグネチャと競合するいくつかのメソッドが、既存のJPAインタフェースに導入されました。このため、WebLogic Server 12.1.1でKodo/JPAを引き続き永続性プロバイダとして使用するアプリケーションは、リコンパイルする必要があります。詳細は、「アプリケーションを更新してJPA 2.0との競合を解決する」を参照してください。

Kodoは、JPA 2.0をサポートしていません。WebLogic ServerのKodoでJPA 2.0 APIを使用しようとすると、エラーが発生します。ただし、特定の永続性ユニットの永続性プロバイダまたはドメインのデフォルト・プロバイダとしてKodoを使用する場合、異なる永続性ユニットでTopLinkが使用できなくなることはありません。詳細は、「Oracle WebLogic ServerでのOracle Kodoの使用」を参照してください。

この付録の内容は次のとおりです。

Oracle Kodoの概要
Oracle Kodoアプリケーションの作成
バージョンの異なるOracle Kodoの使用
永続性の構成
Oracle Kodoアプリケーションのデプロイ
Oracle Kodoアプリケーションの構成

Oracle Kodoの概要

Oracle Kodoは、Java Persistence API (JPA)およびJava Data Objects (JDO)仕様の、透過的なデータ・オブジェクト用の実装です。Oracle Kodoは、スタンドアロン製品として使用することも、WebLogic Serverに統合することもできます。

この章では、WebLogic ServerでJPAやJDOを使用してアプリケーションを実装する方法について説明します。WebLogic Serverでは、JPAおよびJDO実装が、WebLogic Server全体のEnterprise JavaBean 3.0永続性実装の一部になっています。

JPAおよびJDOを使用したアプリケーションの作成の概要は、Oracle WebLogic Server Kodo JPA/JDOリファレンスを参照してください。

Oracle Kodoアプリケーションの作成

WebLogic ServerにOracle Kodoアプリケーションを実装するには、最初にアプリケーションのコードを記述する必要があります。Oracle Kodoを使用してデータの永続性を管理するアプリケーションの記述については、以下のリソースを参照してください。

Oracle Kodoを使用してアプリケーションを作成する手順を理解し、実際にアプリケーションを作成したら、WebLogic Serverを使用してアプリケーションをデプロイおよび構成します。手順については、以降の節を参照してください。

バージョンの異なるOracle Kodoの使用

WebLogic Serverでデフォルトで提供されているOracle Kodoとは異なるバージョンのOracle Kodoを使用する場合は、FilteringClassLoaderを使用して、システム・クラスローダーからではなくアプリケーションからロードするパッケージ(この場合はOracle KodoとOpenJPA)を指定する必要があります。

以下の例では、weblogic-application.xmlを使用して、アプリケーションからOracle KodoおよびOpenJPAパッケージをロードする方法を示します。

<prefer-application-packages>
  <package-name>org.apache.openjpa.*</package-name>
  <package-name>kodo.*</package-name>
</prefer-application-packages>

フィルタ・クラスローダーの詳細は、『Oracle WebLogic Serverアプリケーションの開発』のWebLogic Serverアプリケーションのクラスローディングの理解に関する項を参照してください。

その後で、『Oracle WebLogic Serverアプリケーションの開発』のライブラリ・ディレクトリに関する項で説明するように、ライブラリ・ディレクトリを使用して、Oracle KodoおよびOpenJPAをアプリケーション内にパッケージ化できます。

永続性の構成

以下の節では、永続性を構成する方法について説明します。

構成プロパティ・ファイルを編集する
2種類の構成ファイルを組み合わせて使用する
プラグインを構成する

構成プロパティ・ファイルを編集する

Oracle Kodoでは、次の表に示す2つのXMLファイルを使用して構成プロパティを定義します。

表B-1 永続性構成ファイル

構成ファイル説明

構成ファイル	説明
`persistence.xml`	JPA機能仕様で定義されているOracle Kodo構成パラメータ。このファイルは必須です。この構成を構造化するためのXMLスキーマは、`http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd`から入手できます。詳細は、Oracle WebLogic Server Kodo JPA/JDOリファレンスの第6章「永続性」を参照してください。
`persistence-configuration.xml`	Oracle Kodo固有の構成パラメータ。このファイルは、アプリケーションのデプロイメントにおいて必須ではありません。これを指定する場合でも、`persistence.xml`記述子は必要です。デプロイメントに`persistence-configuration.xml`が含まれていない場合は、各構成パラメータの妥当なデフォルト値が設定されます。この構成を構造化するためのXMLスキーマは、`http://xmlns.oracle.com/weblogic/persistence-configuration/1.0/persistence-configuration.xsd`から入手できます。注意 : Java SE環境で`persistent-configuration.xml`ファイルを使用する場合は、`weblogic.jar`ファイルを`CLASSPATH`に含める必要があります。

persistence.xml

JPA機能仕様で定義されているOracle Kodo構成パラメータ。このファイルは必須です。

この構成を構造化するためのXMLスキーマは、http://java.sun.com/xml/ns/persistence/persistence_1_0.xsdから入手できます。

詳細は、Oracle WebLogic Server Kodo JPA/JDOリファレンスの第6章「永続性」を参照してください。

persistence-configuration.xml

Oracle Kodo固有の構成パラメータ。このファイルは、アプリケーションのデプロイメントにおいて必須ではありません。これを指定する場合でも、persistence.xml記述子は必要です。

デプロイメントにpersistence-configuration.xmlが含まれていない場合は、各構成パラメータの妥当なデフォルト値が設定されます。

この構成を構造化するためのXMLスキーマは、http://xmlns.oracle.com/weblogic/persistence-configuration/1.0/persistence-configuration.xsdから入手できます。

注意 : Java SE環境でpersistent-configuration.xmlファイルを使用する場合は、weblogic.jarファイルをCLASSPATHに含める必要があります。

必要に応じて構成ファイルを編集し、永続性を構成します。永続性ユニットは、WARまたはEJB JARファイルの一部としてパッケージ化するか、WARまたはEARファイルに含めることのできるJARファイルとしてパッケージできます。これらのファイルは、永続性ユニットのルートにあるMETA-INFディレクトリ内のリソースとして使用できるようにする必要があります。永続性ユニットのルートは、コンテナ環境では以下のいずれかになります。

EJB-JARファイル
WARファイルのWEB-INF/classesディレクトリ
WARファイルのWEB-INF/libディレクトリ内のJARファイル
EARのルートにあるJARファイル
EARライブラリ・ディレクトリ内のJARファイル
アプリケーション・クライアントjarファイル

2種類の構成ファイルを組み合わせて使用する

ここでは、これらの構成ファイルを組み合わせて使用する場合の考慮事項について説明します。

persistence-configuration.xmlを使用する場合は、Oracle Kodo固有のすべてのプロパティを、persistence.xmlファイルではなくpersistence-configuration.xmlファイルに含める必要があります。その場合、WebLogic Server管理コンソールとWebLogic Scripting Tool (WLST)では、永続性ユニットがOracle Kodo永続性ユニットとして認識され、高度な構成とチューニング可能なサポートが提供されます。
Oracle Kodo固有のプロパティがpersistence.xmlファイルに含まれていない場合、管理コンソールとWLSTでは、永続性ユニットがサード・パーティの永続性ユニットとして認識されます。
persistence-configuration.xml記述子が使用可能で、特定の永続性ユニットのエントリが含まれている場合は、Oracle Kodo (kodo)やOpenJPA (openjpa)のプロパティを、その永続性ユニットのpersistence.xmlファイルの<properties>タグで指定できます。

プラグインを構成する

Oracle Kodoは高度なカスタマイズが可能な環境であるため、構成プロパティの多くが、システム・プラグインの作成および構成に関係しています。プラグイン・プロパティの構文は、Javaアノテーションの構文によく似ています。プラグイン・プロパティを使用することで、プラグインにどのクラスを使用するか、また、インスタンス化されたプラグイン・インスタンスのパブリック・フィールドやBeanプロパティをどのように構成するかを指定できます。

基本的に、プラグインは名前と値のペアによる一連のプロパティを使用して定義します。次のサンプルでは、persistence.xml内でプラグインを定義する方法を示します。

<properties>
<property name='myplugin.DataCache' value='com.bea.MyDataCache(CacheSize=1000, RemoteHost='CacheServer)'>
</properties>

Oracle Kodoアプリケーションのデプロイ

Oracle Kodoアプリケーションをデプロイする前に、以下のタスクを完了する必要があります。

Oracle Kodoアプリケーションを作成します。詳細については、「Oracle Kodoアプリケーションの作成」を参照してください。
永続性を構成します。詳細については、「永続性の構成」を参照してください。
アプリケーションを作成し、.earまたは.warにアーカイブします。

これらのタスクが完了したら、そのアプリケーションをWebLogic Serverにデプロイできます。構成が完了していれば、Oracle Kodoアプリケーションは他のアプリケーションと同じ方法でデプロイできます。アプリケーションのデプロイメントの詳細は、『Oracle WebLogic Serverへのアプリケーションのデプロイ』を参照してください。

Oracle Kodoアプリケーションの構成

注意:

管理コンソールでは、新しい永続性ユニットを作成することはできません。新しい永続性ユニットを作成するには、persistence.xmlを手動で編集する必要があります。

Oracle Kodoアプリケーションをデプロイしたら、persistence.xmlおよびpersistence-configuration.xmlで定義されている構成パラメータを変更できます。

以下の節では、Oracle Kodoアプリケーションを管理コンソールで構成する方法と、管理コンソールを使用せずに構成する方法について説明します。

管理コンソールを使用する

デプロイしたアプリケーションの永続性がpersistence.xmlで定義されている場合は、次の手順で管理コンソールから構成にアクセスできます。

「デプロイメント」を選択します。
構成したい永続性ユニットが含まれているモジュールの名前を選択します。
「構成」タブを選択します。
「永続性」タブを選択します。
表示された一覧から、構成する永続性ユニットを選択します。

これによって、管理コンソールで編集可能なすべてのOracle Kodo永続性パラメータにアクセスできるようになります。

管理コンソールを使用せずにOracle Kodoアプリケーションを構成する

管理コンソールを使用できない環境でパラメータを変更する必要がある場合は、以下の方法で変更できます。

アプリケーションと一緒にアーカイブされているpersistence.xmlおよびpersistence-configuration.xmlファイルを手動で編集します。
SessionHelperを使用してデプロイメント・プランにアクセスして構成します。詳細は、『WebLogic Deployment APIによるアプリケーションのデプロイ』の「WebLogicデプロイメントAPIの理解」のToolsパッケージに関する項のSessionHelperを参照してください。
WLST loadApplication()メソッドを使用して、アプリケーション・デプロイメント・プランをロードして更新します。詳細は、『WebLogic Scripting Toolの理解』の「デプロイメント・プランの更新」を参照してください。
デプロイメント・プランを手動で編集します。詳細は、『Oracle WebLogic Serverへのアプリケーションのデプロイ』のデプロイするアプリケーションの新しい環境へのエクスポートに関する項のデプロイメント・プランの手動カスタマイズに関する項を参照してください。