WebLogic エンタープライズ JavaBeans (EJB) プログラマーズ ガイド
以下の節では、weblogic 固有の XML 文書型定義 (DTD) ファイル、weblogic-cmp-jar.xml
ファイルの EJB 2.0 デプロイメント記述子要素について説明します。これらの定義を使用して、EJB デプロイメントを構成する WebLogic 固有の weblogic-cmp-jar.xml
ファイルを作成します。このデプロイメント記述子ファイルを使用して、コンテナ管理による永続性 (CMP) の動作を指定します。
EJB 1.1 デプロイメント記述子要素については、「EJB 1.1 ユーザへの重要な情報」を参照してください。
weblogic-cmp-jar.xml
ファイルは、WebLogic Server の RDBMS ベースの永続性サービスを使用するエンティティ EJB のデプロイメント記述子を定義します。EJB コンテナでは、WebLogic Server バージョン 6.x で提供された XML とは異なるバージョンの weblogic-cmp-jar.xml
を使用します。
WebLogic Server バージョン 8.1 にデプロイする旧バージョンの EJB 1.1 用 weblogic-cmp-jar.xml
の DTD も使用できます。ただし、CMP 2.0 の新機能を使用する場合は、下記の新しい DTD を使用する必要があります。
WebLogic Server 8.1 の weblogic-cmp-jar.xml
の最上位要素は、weblogic-rdbms-jar
スタンザで構成されます。
description
weblogic-version
weblogic-rdbms-jar
weblogic-rdbms-bean
ejb-name
data-source-name
table-map
field-group
relationship-caching
weblogic-query
delay-database-insert-until
automatic-key-generation
check-exists-on-method
weblogic-rdbms-relation
relation-name
table-name
weblogic-relationship-role
order-database-operations
enable-batch-operations
create-default-dbms-tables
validate-db-schema-with
database-type
default-dbms-tables-ddl
互換性 (compatibility)
WebLogic Server 8.1 では、weblogic-cmp-jar.xml
に対して以下の変更が加えられました。
weblogic-cmp-jar.xml
の要素のこのリストには、WebLogic Server 8.1 のサービス パックでサポートされていたすべての要素が含まれています。前節「WebLogic Server 8.1 での weblogic-cmp-jar.xml の変更点」では、WebLogic Server 8.1 またはそれ以降のサービス パックで追加、変更、または非推奨化された要素がリストされています。
WebLogic Server 8.1 SP02 で導入されたこの要素は、下位互換性のフラグです。ReadOnly
同時方式を使用する EJB で作成と削除を有効にするために使用します。
バージョン 8.1 SP2 より前は、それらの処理は許可されていました (ただしトランザクションとしての意味はなかった)。ReadOnly
Bean でより効率的なコードを生成できるように、およびそれらを使用するのがプラクティスとして良くないという理由から、作成と削除は許可されなくなっています。
<compatibility>
<allow-readonly-create-and-remove>
true
</allow-readonly-create-and-remove>
</compatibility>
automatic-key-generation
要素は、主キーが自動的に生成される方法を指定します。この機能の詳細については、「主キーの自動生成」を参照してください。
以下のコード サンプルは、さまざまな主キー生成方法の automatic-key-generation
スタンザを示しています。サポートされている生成方法については、「generator-type」を参照してください。
コード リスト B-1 generator-type=Oracle の automatic-key-generation
<automatic-key-generation>
<generator-type>Oracle</generator-type>
<generator-name>test_sequence</generator-name>
<key-cache-size>10</key-cache-size>
</automatic-key-generation>
コード リスト B-2 generator-type=SQL-SERVER の automatic-key-generation
<automatic-key-generation>
<generator-type>SQL-SERVER</generator-type>
</automatic-key-generation>
コード リスト B-3 generator-type=NamedSequenceTable の automatic-key-generation
<automatic-key-generation>
<generator-type>NamedSequenceTable</generator-type>
<generator-name>MY_SEQUENCE_TABLE_NAME</generator-name>
<key-cache-size>100</key-cache-size>
</automatic-key-generation>
関連する Bean で cmr-field
と group-name
を指定します。group-name
を指定しなかった場合、デフォルトの group-name
(全フィールドをロード) が使用されます。詳細については、「group-name」を参照してください。
caching-element
スタンザでは、relationship-caching の例のようにネストされた caching-element スタンザを格納できます。
リレーションシップ キャッシングについては、「リレーションシップ キャッシング」を参照してください。
「relationship-caching」を参照してください。
caching-name
要素は、リレーションシップ キャッシュの名前を指定します。リレーションシップ キャッシングの詳細については、「リレーションシップ キャッシング」を参照してください。
「relationship-caching」を参照してください。
デフォルトでは、EJB コンテナはコンテナ管理による永続性 (CMP) エンティティ Bean の有無を、Bean 上で呼び出されたビジネス メソッドが完了する前にチェックします。これは、削除されたコンテナ管理のエンティティ Bean 上で何らかのビジネス メソッドが呼び出されると、直ちにコンテナがアプリケーションに対して通知を行うことを意味します。
EJB コンテナが、存在するかどうかのチェックをする前にトランザクションの完了を待機するように指定するには、check-exists-on-method
を False
に設定します。これにより、大半のアプリケーションで高いパフォーマンスを実現しつつ、十分なレベルのチェックが提供されます。
次の例では、削除された CMP エンティティ Bean 上でビジネス メソッドが呼び出されたことを WebLogic Server がアプリケーションに通知するように指定しています。
<check-exists-on-method>True</check-exists-on-method>
この名前は、Bean インスタンスのマップされたフィールドを指定します。Bean インスタンスのフィールドには、データベースから取得した情報が指定されている必要があります。
「field-map」を参照してください。
<cmr-field>stock options</cmr-field>
この要素は、データベース内のテーブルの外部キー カラムと対応する主キーのマッピングを表します。2 つのカラムは同じテーブルにある場合も別のテーブルにある場合もあります。カラムが属しているテーブルは、column-map
要素がデプロイメント記述子に表示されるコンテキストに対しては暗黙的です。
注意 : foreign-key-column
がリモート Bean を参照する場合は、key-column
要素を指定しないこと。
<column-map
<foreign-key-column>account-id</foreign-key-column>
<key-column>id</key-column>
</column-map>
WebLogic Server 8.1 SP02 で導入された <compatibility>
スタンザでは、記述子ファイルで記述されているすべての cmp Bean の互換性フラグを指定する要素を設定します。
<compatibility>
<serialize-byte-array-to-oracle-blob>
<allow-readonly-create-and-remove>
</compatibility>
create-default-dbms-table
要素は、以下の 2 つの機能を実行します。
この要素は、開発段階で役立つ場合にのみ使用します。使用する DBMS CREATE
文のテーブル スキーマがコンテナの最適な定義になります。プロダクション環境では通常、より正確なスキーマ定義が必要です。
次の表は、WebLogic Server が create-default-dbms-tables
の値に基づいてどのように自動テーブル作成を処理するのかを説明しています。
TABLE CREATION
が失敗した場合、サーバは Table Not Found
エラーを送出するので、テーブルを手動で作成しなければなりません。
「自動テーブル作成 (開発のみ)」を参照してください。
注意 : 自動 Oracle SEQUENCE 生成は、開発モードで動作しているサーバでのみ機能します。
次の表は、WebLogic Server が create-default-dbms-tables
の値に基づいてどのように自動 SEQUENCE 生成を処理するのかを説明しています。
|
|
|
|
|
|
|
Oracle SEQUENCE の自動生成の詳細については、「Oracle SEQUENCE のサポート」を参照してください。
次の例では、create-default-dbms-tables 要素を指定します。
<create-default-dbms-tables>CreateOnly</create-default-dbms-tables>
database-type
要素は、基盤 DBMS として使用するデータベースを指定します。
<database-type>POINTBASE</database-type>
この Bean のデータベース接続で使用する JDBC データ ソース名を指定します。データソースの詳細については、『WebLogic JDBC プログラマーズ ガイド』を参照してください。
「table-name」を参照してください。
アプリケーションが、データベースに組み込まれているカスケード削除のサポートを利用し、パフォーマンスを向上できるようにする。この機能は、以下の場合にのみサポートされます。
weblogic-cmp-rdbms-jar.xml
で db-cascade-delete
が有効になっている場合は、以下のようにする必要があります。
注意 : db-cascade-delete
を指定しない場合は、データベースのカスケード削除機能を有効にしないようにしてください (結果が不正確になるため)。
次の Oracle テーブル定義では、データベースで親の dept
が削除されると emp
行がすべて削除されます。
CREATE TABLE dept
(deptno NUMBER(2) CONSTRAINT pk_dept PRIMARY KEY,
dname VARCHAR2(9) );
CREATE TABLE emp
(empno NUMBER(4) PRIMARY KEY,
ename VARCHAR2(10),
deptno NUMBER(2) CONSTRAINT fk_deptno
REFERENCES dept(deptno)
ON DELETE CASCADE );
</weblogic-relationship-role>
<db-cascade-delete/>
</weblogic-relationship-role>
注意 : 大文字/小文字を区別しないデータベースの場合でも、dbms-column
では大文字/小文字を区別する。
「field-map」を参照してください。
cmp-field
の型を指定します。現在のフィールドを Oracle データベース内の Blob または Clob、または Sybase データベース内の LongString または SybaseBinary にマップします。
OracleBlob
- フィールドを Oracle Blob にマップします。OracleClob
- フィールドを Oracle Clob にマップします。LongString
- setCharacterStream
を使用して文字列データをデータベースに書き込むようにコンテナに通知します。一部の JDBC ドライバでは、4KB を超えるデータを setString
で書き込むことに問題があります。SybaseBinary
- setBytes
を使用してバイトをバイナリ カラムに書き込むようにコンテナに通知します (setBinaryStream
が SybaseXADriver
では機能しないため)。
<field-map>
<cmp-field>photo</cmp-field>
<dbms-column>PICTURE</dbms-column>
<dbms_column-type>OracleBlob</dbms-column-type>
</field-map>
EJB コンテナがテーブル作成スクリプトを記述する DDL
ファイル名を指定します。
新しい CMP Bean がいつデータベースに挿入されるのかを指定します。指定可能な値で、以下の動作が行われます。
ejbCreate
- ejbCreate の直後にデータベースの挿入を実行します。
この設定の場合は、不要な格納操作を避けることで ejbCreate
よりもパフォーマンスが良くなります。ejbPostCreate
- ejbPostCreate
の直後に挿入を実行します。この要素は、order-database-operations が False
の場合のみ有効です。デフォルトでは、order-database-operations
は true
です。デフォルトの場合は、トランザクションがコミットされたときに新しい Bean が挿入されます。
cmr-field
が null 値を許可しない foreign-key
カラムにマップされている場合、データベースの挿入は ejbPostCreate
の後まで遅延する必要があります。この場合、cmr-field
を ejbPostCreate
で null 以外の値に設定してから Bean をデータベースに挿入しなければなりません。
最大限の柔軟性を実現するため、関連 Bean を ejbPostCreate
メソッドで作成することは避けてください。ejbPostCreate
で関連 Bean が作成され、データベースの制約によって関連 Bean が未作成の Bean を参照できない場合は、メソッドが完了するまでデータベースの挿入は実行できません。
注意 : cmr-field
は、Bean の主キーが不明な段階で ejbCreate
の中で設定することはできません。
<delay-database-insert-until>ejbPostCreate</delay-database-insert-until>
description
要素は、親要素を示すテキストの指定に使用します。
<dscription>親要素の説明</description>
ejb-cmp-rdbms.xml
で定義した EJB を指定する名前です。この名前は、ejb-jar.xml
で定義した CMP エンティティ Bean の ejb-name
に一致している必要があります。
「table-name」を参照してください。
WebLogic Server 8.1 で導入されたこの要素は、EJB コンテナがデータベースのバッチ処理を許可するのかどうかを管理します (バッチ挿入、バッチ更新、およびバッチ削除を含む)。
この要素を True
に設定すると、EJB はトランザクション中のデータベース処理をコミット時間まで遅延させます。
注意 : WebLogic Server 8.1 では、この要素は delay-database-insert-until 要素の commit
設定 (WebLogic Server 7.0) の機能の代わりに使用します。
次の XML サンプルでは、enable-batch-operations
要素の使い方を示します。
<enable-batch-operations>True</enable-batch-operations>
field-group
要素は、Bean の cmp-field と cmr-field のサブセットを表します。Bean 内の関連フィールドを、障害のあったグループに 1 つのユニットとしてまとめることができます。グループをファインダまたは関係に関連付けることができます。それによって、ファインダを実行するか、または関係に従った結果として Bean がロードされたときに、グループ内の指定フィールドのみがロードされます。
フィールドは複数のグループに関連付けられている場合があります。この場合、フィールドに対して getXXX
メソッドを実行すると、そのフィールドを含む最初のグループで障害が発生します。
<weblogic-rdbms-bean>
<ejb-name>XXXBean</ejb-name>
<field-group>
<group-name>medical-data</group-name>
<cmp-field>insurance</cmp-field>
<cmr-field>doctors</cmr-fields>
</field-group>
</weblogic-rdbms-bean>
field-map
要素は、データベースの特定のカラムと Bean インスタンスの cmp-field
の間のマッピングを表します。
任意指定の group-name
要素は、cmp-field
の getXXX
メソッドが呼び出され、値がメモリにないために、EJB コンテナが DBMS から値を読み込む必要がある場合にロードされるフィールド グループを指定します。group-name
を省略すると、cmp-field
がどのフィールド グループでも明示的にリストされていない場合はデフォルト グループ (すべての cmp-field
が含まれている) が使用されます。明示的にリストされている場合には、cmp-field
のあるフィールド グループが選択されます。したがって、cmp-field
が複数のフィールド グループでリストされている場合、またはコンテナがグループのいずれかを任意に選択する場合、開発者は group-name
を指定する必要があります。
「dbms-column-type」を参照してください。
<field-map>
<cmp-field>....</cmp-field>
<dbms-column>...</dbms-column>
<dbms-column-type>...</dbms-column-type>
<group-name>...</group name>
</field-map>
foreign-key-column
要素は、データベース内の外部キーのカラムを表します。
「column-map」を参照してください。
foreign-key-table
要素は、外部キーを格納する DBMS テーブル名を指定します。
「relationship-role-map」を参照してください。
generator-name
要素は、主キー ジェネレータの名前を指定する場合に使用します。
Oracle
で、WebLogic Server が開発モードで動作している場合、EJB コンテナは自動 SEQUENCE 生成機能の過程で generator-name
に「_WL」を追加してその Oracle SEQUENCE の名前を作成します。Oracle SEQUENCE の自動生成の詳細については、「Oracle SEQUENCE のサポート」を参照してください。
generator-type
要素が Oracle
で、WebLogic Server がプロダクション モードで動作している場合、EJB コンテナは Oracle SEQUENCE の名前を generator-name
の値に設定します。generator-type
要素が NamedSequenceTable
の場合、generator-name
要素は使用される SEQUENCE_TABLE
の名前になります。「automatic-key-generation」を参照してください。
generator-type
要素は、使用する主キー生成方法を指定します。
また、generator-type
は Oracle SEQUENCE の自動生成でも使用します。「Oracle SEQUENCE のサポート」を参照してください。
「automatic-key-generation」を参照してください。
「field-group」を参照してください。
現在のトランザクション中の更新を必ずクエリの結果に反映するかどうかを指定します。この要素を True
に設定した場合、コンテナは現在のトランザクションによる変更をすべてディスクにフラッシュしてからクエリを実行します。値を False
にすると、最高のパフォーマンスが得られます。
<weblogic-query>
<query-method>
<method-name>findBigAccounts</method_name>
<method-params>
<method-param>double</method-param>
</method-params>
</query-method>
<weblogic-ql>WHERE BALANCE>10000 ORDERBY NAME</weblogic-ql>
<include-updates>True</include-updates>
</weblogic-query>
特定 EJB のインスタンスのロックまたは処理順序を指定します。この要素は、この要素を使用しなければデッドロックが起こるアプリケーションでデッドロックを防止するために使用できます。instance-lock-order
は、同じ EJB の複数のインスタンスに適用されるデータベース操作 (更新など) がコンテナによって実行される場合に常に使用します。この要素は、Bean インスタンスでデータベース ロックを取得させる操作の順序を指定します。
たとえば、instance-lock-order
を使用すると、Database 同時方式を使用する特定の EJB インスタンスで EJB コンテナが ejbStore
を呼び出す順序を指定できます。ejbStore
は、データベースが更新されるときに排他的ロックを取得できます。instance-lock-order
は、Optimistic 同時方式を使用する Bean がオプティミスティック チェックの実行時にロックされる順序も制御します。
AccessOrder
- コンテナは、トランザクションの過程でアプリケーションが Bean にアクセスした順序でロックが取得 (またはアップグレード) されるように Bean を処理します。これは、システムのすべてのトランザクションが Bean のインスタンス (最終的にはデータベース テーブルの行) に同じ順序でアクセスする場合の推奨値です。instance-lock-order
- ValueOrder
- Bean は、主キーの値に基づく順序で処理されます。複数の同時トランザクションが異なる順序で同じ EJB のインスタンスにアクセスする場合のデッドロックを防止するために、ValueOrder
を指定する必要があります。注意 : ValueOrder
が指定されている場合、EJB の主キー クラスは java.lang.Comparable
インタフェースを実装する必要がありません (ただし、全体的な順序付けになる)。主キーが java.lang.Comparable
を実装しない場合、Bean は主キーのハッシュ コード値を使用して部分的に順序付けされます。
<instance-lock-order>ValueOrder</instance-lock-order>
自動主キー生成機能で利用可能な主キー キャッシュのサイズをオプションとして指定します。また、EJB コンテナは自動 SEQUENCE 生成が有効なときにはこの値を使用して Oracle SEQUENCE のインクリメント値を計算します。 「Oracle SEQUENCE のサポート」を参照してください。
generator-type の値が、
Oracle
である場合、key-cache-size
は Oracle SEQUENCE INCREMENT 値と一致していなければなりません。この値と Oracle SEQUENCE INCREMENT 値が一致していない場合は、キー重複の問題が起こります。NamedSequenceTable
である場合、key-cache-size
は 1 回の DBMS 呼び出しでコンテナが取得するキーの数を指定します。key-cache-size
は無視されます。「automatic-key-generation」を参照してください。
key-column
要素は、データベース内の主キーのカラムを表します。
「column-map」を参照してください。
このフラグを使用すると、トランザクションに複数の Bean および排他的同時実行性が関与する場合に、エンティティ Bean のデータベース ロックの順番を指定できます。最も小さい数値を付けられた Bean が最初にロックされます。
このフラグは、デッドロック状況を回避するためのみに使用します。また、現在はトランザクションがカスケード削除を実行する場合にしか適用されません。このフラグは現在、カスケード削除にのみ使用されます。
<lock-order>1</lock-order>
<!ELEMENT lock-order (PCDATA)>
max-elements
は多値クエリによって返される要素の最大数を指定します。この要素は、JDBC の maxRows
機能とほぼ同じです。
<max-elements>100</max-elements>
<!ELEMENT max-element (PCDATA)>
method-name
要素は、ファインダ メソッドまたは ejbSelect
メソッドの名前を指定します。
「weblogic-query」を参照してください。
method-param
要素には、Java タイプのメソッド パラメータの完全修飾名が含まれます。
<method-param>java.lang.String</method-param>
method-params
要素には、Java タイプのメソッド パラメータの完全修飾名の順序付きリストが含まれます。
「weblogic-query」を参照してください。
optimistic-column
要素は、オプティミスティックな同時実行性を実装するためのバージョン値またはタイムスタンプ値を格納するデータベース カラムを示します。オプティミスティックな同時実行性の詳細については、「同時方式の選択」を参照してください。
注意 : すべてのデータベースで大文字と小文字が区別されるわけではありませんが、この要素では、大文字と小文字を区別します。
次の XML 例では、optimistic-column
要素の使い方を示します。
<optimistic-column>ROW_VERSION</optimistic-column>
ROW_VERSION
は、同時方式のチェックに使用する値が格納されるデータベース カラムの名前です。
WebLogic Server 8.1 で導入されたこの要素は、EJB コンテナが、トランザクション内のすべてのデータベース処理をコミット時間まで遅延し、処理間でのデータベースの依存関係を自動的にソートし、これらの処理を、一切のデータベース制約エラーが生じない方式でデータベースに送るかどうかを決定します。
enable-batch-operations が True
の場合、コンテナは自動的に order-database-operations
を True
に設定します。order-database-operations
を無効にするには、order-database-operations
と enable-batch-operations
の両方を False
に設定します。
「enable-batch-operations」と「delay-database-insert-until」も参照してください。
次の XML 例では、order-database-operations
要素の使い方を示します。
<order-database-operations>True</order-database-operations>
primary-key-table
要素は、主キーを格納する DBMS テーブル名を指定します。主キーの詳細については、「主キーの使用」を参照してください。
注意 : すべてのデータベースで大文字と小文字が区別されるわけではありませんが、この要素では、大文字と小文字を区別します。
例については、「relationship-role-map」および「関係の主キー側の Bean の複数テーブルへのマッピング」を参照してください。
weblogic-query
と関連付けられたメソッドを指定します。ejb-jar.xml
記述子と同じ形式を使用します。
「weblogic-query」を参照してください。
コンテナ管理による関係の詳細については、「コンテナ管理による関係 (CMR) の使用」を参照してください。
<weblogic-rdbms-jar>
<weblogic-rdbms-relation>
<relation-name>stocks-holders</relation-name>
<table-name>stocks</table-name>
</weblogic-rdbms-relation>
</weblogic-rdbms-jar>
relation-caching
要素は、リレーションシップ キャッシングを指定します。リレーションシップ キャッシングの詳細については、「リレーションシップ キャッシング」を参照してください。
<relationship-caching>
<caching-name>cacheMoreBeans</caching-name>
<caching-element>
<cmr-field>accounts<</cmr-field>
<group-name>acct_group</group-name>
<caching-element>
<cmr-field>address</cmr-field>
<group-name>addr_group</group-name>
</caching-element>
</caching-element>
<caching-element>
<cmr-field>phone</cmr-field>
<group-name>phone_group</group-name>
</caching-element>
</relationship-caching>
relationship-role-map
要素は、ある関係に加わっている Bean のキーカラム マッピングに対する外部キー カラムを指定します。
関係の中で呼び出される CMP Bean は、複数の DBMS テーブルにマップできます (詳細については、table-map 要素を参照)。1 対 1 または 1 対多の関係の外部キー側の Bean が複数のテーブルにマップされている場合は、外部キー カラムが含まれるテーブルの名前を foreign-key-table
要素で指定する必要があります。
逆に、1 対 1 または 1 対多の関係の主キー側の Bean または多対多の関係に参加している Bean が複数のテーブルにマップされている場合は、主キーが含まれるテーブルの名前を primary-key-table
要素で指定する必要があります。
関係のどちら側の Bean も複数のテーブルにマップされていない場合、foreign-key-table
要素と primary-key-table
要素は省略可能です (使用されるテーブルが暗黙的であるため)。
コンテナ管理による関係の詳細については、「コンテナ管理による関係 (CMR) の使用」を参照してください。
1 対 1 の関係の外部キー側の Bean (Fk_Bean
) は、複数のテーブルにマップされます。外部キー カラムを持つテーブルは、foreign-key-table
要素で指定する必要があります。
Fk_Bean
は、2 つのテーブル Fk_BeanTable_1
と Fk_BeanTable_2
にマップされます。関係の外部キー カラムは、テーブル Fk_BeanTable_2
にあります。外部キー カラムの名前は、Fk_column_1
と Fk_column_2
です。主キー側の Bean (Pk_Bean
) は、主キー カラム Pk_table_pkColumn_1
と Pk_table_pkColumn_2
を持つ 1 つのテーブルにマップされています。
<relationship-role-map
<foreign-key-table>Fk_BeanTable_2</foreign-key-table>
<column-map>
<foreign-key-column>Fk_column_1</foreign-key-column>
<key-column>Pk_table_pkColumn_1</key-column>
</column-map>
<column-map>
<foreign-key-column>Fk_column_2</foreign-key-column>
<key-column>Pk_table_pkColumn_2</key-column>
</column-map>
</relationship-role-map>
外部キー カラムのあるテーブルをコンテナが確認できるように、foreign-key-table
要素は必ず指定します。
1 対 1 の関係の主キー側の Bean (Pk_bean
) は複数のテーブルにマップされますが、その関係の外部キー側の Bean (Fk_Bean
) は 1 つのテーブル Fk_BeanTable
にマップされます。外部キー カラムの名前は、Fk_column_1
と Fk_column_2
です。
Pk_BeanTable_1
。主キー カラムは、Pk_table1_pkColumn_1
と Pk_table1_pkColumn_2
。 Pk_BeanTable_2
。主キー カラムは、Pk_table2_pkColumn_1
と Pk_table2_pkColumn_2
。 <relationship-role-map>
<primary-key-table>Pk_BeanTable_1</primary-key-table>
<column-map>
<foreign-key-column>Fk_column_1</foreign-key-column>
<key-column>Pk_table1_pkColumn_1</key-column>
</column-map>
<column-map>
<foreign-key-column>Fk_column_2</foreign-key-column>
<key-column>Pk_table1_pkColumn_2</key-column>
</column-map>
</relationship-role-map>
relationship-role-name
要素は関係のロール名を指定します。
コンテナ管理による関係の詳細については、「コンテナ管理による関係 (CMR) の使用」を参照してください。
「weblogic-relationship-role」の例を参照してください。
WebLogic Server 8.1 SP02 で導入されたこの要素は、互換性フラグです。この要素を使用すると、OracleBlob にマップされた byte[]
型の cmp-field がシリアライズされるべきかどうかを指定できます。デフォルトでは、このフラグの値は false
です。つまり、コンテナは byte[]
を直接保持し、シリアライズはしません。
WebLogic Server 8.1 SP02 より前のバージョンでは、OracleBlob にマップされた byte[] 型の cmp-field はシリアライズするのがデフォルトの動作でした。旧式の動作に戻るには、serialize-byte-array-to-oracle-blob
の値を true に設定します。
<compatibility>
<serialize-byte-array-to-oracle-blob>
true
</serialize-byte-array-to-oracle-blob>
</compatibility>
注意 : この要素は非推奨です。同じ機能を得るには、ファインダ クエリで SELECT DISTINCT
句を直接使用してください。
sql-select-distinct
要素は、生成される SQL SELECT 文に DISTINCT 修飾子が含まれるかどうかを指定します。DISTINCT 修飾子を使用すると、データベースからユニークな行が返されます。
Oracle データベースでは、FOR UPDATE
句を SELECT DISTINCT
と一緒に使用することはできません。したがって、呼び出しチェーンの Bean に isolation-level
が TransactionReadCommittedForUpdate
のメソッドがある場合は、sql-select-distinct
要素を使用できません。transaction-isolation
要素は weblogic-ejb-jar.xml
で指定します。
<sql-select-distinct>True</sql-select-distinct>
CMP Bean は、1 つまたは複数の DBMS テーブルにマップできます。table-map
要素は、Bean の cmp-field と、テーブルにマップされたすべての cmp-field
のテーブル カラムの間のマッピングを指定します。CMP Bean を複数の DBMS テーブルにマップする場合は、テーブルごとに table-map
要素を指定する必要があります。
1 つの CMP Bean を複数のテーブルにマップする場合、各テーブルには、1 つの特定の Bean インスタンスにマップする 1 行が含まれます。そのため、すべてのテーブルにはどの時点でも同数の行が含まれます。また、各テーブルには均一の主キーの値の並びが含まれます。したがって、各テーブルには均一の主キー カラムが含まれ、別々のテーブルの対応している主キー カラムどうしは名前は違うとしても同じタイプでなければなりません。
table-map
要素は、特定テーブルの主キー カラムから、Bean の主キー カラム フィールドへのマッピングを指定しなければなりません。主キー以外のフィールドは 1 つのテーブルにマップできるのみです。
verify-rows、verify-columns、および optimistic-column 要素の使い方については、「Optimistic 同時方式でのデータ有効性のチェック」を参照してください。
<table-map>
<table-nme>DeptTable</table-name>
<field-map>
<cmp-field>deptId1</cmp-field>
<dbms-column>t1_deptId1_column</dbms-column>
</field-map>
<field-map>
<cmp-field>deptId2</cmp-field>
<dbms-column>t1_deptId2_column</dbms-column>
</field-map>
<field-map>
<cmp-field>location</cmp-field>
<dbms-column>location_column</dbms-column>
</field-map>
<cmp-field>budget</cmp-field>
<dbms-column>budget</dbms-column>
</field-map>
<verify-rows>Read</verify-rows>
<verify-columns>Version</verify-columns>
<optimistic-column>ROW_VERSION
</optimistic-column>
</table-map>
テーブルの完全修飾 SQL 名です。この Bean の data-source
用に定義したユーザには、指定したテーブルの読み取りおよび書き込み特権が必要ですが、スキーマ変更特権は必要ありません。
<weblogic-rdbms-jar>
<weblogic-rdbms-bean>
<ejb-name>containerManaged</ejb-name>
<data-source-name>examples-dataSource-demoPool</data-source-name>
<table-name>ejbAccounts</table-name>
</weblogic-rdbms-bean>
</weblogic-rdbms-jar>
Bean 単位でペシミスティックな同時方式を強制します。True
を指定すると、Bean がデータベースからロードされるときは常に SELECT ... FOR UPDATE
が使用されます。TransactionReadCommittedForUpdate
のトランザクション アイソレーション レベルとの相違点は、これがトランザクション レベルではなく、Bean レベルで設定されるということです。
<weblogic-rdbms.jar>
<weblogic-rdbms-bean>
ejb-name>containerManaged</ejb-name>
<use-select-for-update>True</use-select-for-update>
</weblogic-rdbms-bean>
</weblogic-rdbms-jar>
validate-db-schema-with
要素を指定すると、デプロイメント時に Bean が有効なデータベース スキーマにマップされているかどうかをコンテナ管理による永続性でチェックします。
MetaData
を指定すると、WebLogic Server は、JDBC メタデータを使用してスキーマを検証します。
TableQuery
(デフォルト設定) を指定すると、WebLogic Server は、テーブルを直接クエリし、CMP 実行時によって予期されているスキーマがテーブルにあるかどうかを確認します。
<validate-db-schema-with>TableQuery</validate-db-schema-with>
verify-columns
要素は、Optimistic
同時方式を使用したときに、WebLogic Server に有効性をチェックさせたいテーブル カラムを指定します。WebLogic Server は、トランザクションの終了時、データベースにコミットする前にカラムをチェックし、他のどのトランザクションもそのデータを変更していないことを確かめます。
詳細については、「同時方式の選択」を参照してください。
<verify-columns>Modified</verify-columns>
verify-rows
要素は、オプティミスティックな同時実行性の使用時に EJB コンテナがチェックすべきである、テーブル内の行を指定します。
Modified
- トランザクションで更新または削除された行のみがチェックされます。この値にすると、2 つのトランザクションが同時に同じ行を更新することがなく、更新が損失することはありませんが、異なるトランザクションで読み込みと更新を交互に行うことは可能です。その結果、得られる一貫性のレベルは、ANSI の READ_COMMITTED
レベルと REPEATABLE_READ
レベルの間になります。Read
- トランザクションで読み込まれた行はすべてチェックするように指定します。これには、単に読み込まれるだけの行と、読み込まれた後でトランザクションによって更新または削除される行の、両方が含まれます。Read
の値を指定すると、一般に EJB コンテナが実行しなくてはならないオプティミスティック チェックの回数が増えるため、オーバーヘッドが増加します。「Read
」オプションを指定すると、コミットされたトランザクションは、トランザクションのコミット後まで別のトランザクションによって修正されないことが確認されている一連の行を読み込みます。この結果、SERIALIZABLE
の一貫性の ANSI 定義と非常に近い、高度な一貫性が得られます。注意 : verify-rows
が Read
に設定されていると、verify-columns
要素は Modified
の値を持てない可能性があります。この組み合わせでは、EJB コンテナのチェックは修正された行にのみ行われると考えられるためです。
詳細については、「同時方式の選択」を参照してください。
<verify-rows>Modified</verify-rows>
weblogic-ql
要素は、EJB-QL に対する WebLogic 固有の拡張機能を含むクエリを指定します。ejb-jar.xml
デプロイメント記述子では、EJB-QL 言語の標準機能だけを使用するクエリを指定しなければなりません。
「weblogic-query」を参照してください。
weblogic-query
要素を使用すると、必要に応じて、WebLogic 固有の属性をクエリに関連付けることができます。たとえば、WebLogic 固有の EJB-QL に対する拡張機能を含むクエリを指定するために使用できます。EJB-QL に対する WebLogic の拡張機能を使用しないクエリは、
ejb-jar.xml
デプロイメント記述子で指定する必要があります。
また、クエリによってあらかじめキャッシュにロードしておく必要があるエンティティ Bean をクエリで取得する場合は、weblogic-query
要素を使用して、field-group
をクエリに関連付けます。
<weblogic-query>
<description>...</description>
<query-method>
<method-name>findBigAccounts</method-name>
<method-params>
<method-param>double</method-param>
</method-params>
<query-method>
<weblogic-ql>WHERE BALANCE>10000 ORDERBY NAME
</weblogic-ql>
<group-name>...</group-name>
<caching-name>...</caching-name>
<max-elements>...</max-elements>
<include-updates>...</include-updates>
<sql-select-distinct>...</sql-select-distinct>
</weblogic-query>
weblogic-rdbms-bean
は、WebLogic RDBMS CMP 永続性タイプによって管理されるエンティティ Bean を指定します。
weblogic-rdbms-bean
ejb-name
data-source-name
table-map
field-group
relationship-caching
weblogic-query
dalay-database-insert-until
automatic-key-generation
check-exists-on-method
weblogic-rdbms-jar
要素は、WebLogic RDMBS CMP デプロイメント記述子の最上位の要素です。この要素には、1 つまたは複数のエンティティ Bean と、一連の関係 (これについては省略可能) についてのデプロイメント情報が含まれます。
weblogic-rdbms-jar
の XML
構造を示します。
weblogic-rdbms-jar
weblogic-rdbms-bean
weblogic-rdbms-relation
create-default-dbms-tables
validate-db-schema-with
database-type
weblogic-rdbms-relation
要素は、WebLogic CMP 永続性タイプによって管理されている 1 つの関係を表します。WebLogic Server では、以下の 3 種類の関係のマッピングをサポートしています。
コンテナ管理による関係の詳細については、「コンテナ管理による関係 (CMR) の使用」を参照してください。
1 対 1、1 対多、および多対多の関係のコンフィグレーション方法の例については、以降の節を参照してください。
コード リスト 8-3 は、コードリスト 8-1 および コード リスト 8-2 で定義されているエントリ間の 1 対 1 の関係を定義する weblogic-rdbms-bean
スタンザを示しています。weblogic-rdbms-relation
スタンザは、weblogic-cmp-jar.xml
ファイルの weblogic-rdbms-bean
スタンザの後に位置します。
<weblogic-rdbms-bean>
<ejb-name>CountryEJB</ejb-name>
<data-source-name>wlsd21-datasource</data-source-name>
<table-map>
<table-name>EXAMPLE07_COUNTRY</table-name>
<field-map>
<cmp-field>name</cmp-field>
<dbms-column>NAME</dbms-column>
</field-map>
<field-map>
<cmp-field>continent</cmp-field>
<dbms-column>CONTINENT</dbms-column>
</field-map>
</table-map>
</weblogic-rdbms-bean>
<weblogic-rdbms-bean>
<ejb-name>CapitalEJB</ejb-name>
<data-source-name>wlsd21-datasource</data-source-name>
<table-map>
<table-name>EXAMPLE07_CAPITAL</table-name>
<field-map>
<cmp-field>CAPITAL_NAME</cmp-field>
<dbms-column>NAME</dbms-column>
</field-map>
<field-map>
<cmp-field>continent</cmp-field>
<dbms-column>CONTINENT</dbms-column>
</field-map>
</table-map>
</weblogic-rdbms-bean>
コード リスト 8-3 1 対 1 の関係の <weblogic-rdbms-relation> スタンザ
<weblogic-rdbms-relation>
<relation-name>CountryCapitalRel</relation-name>
<weblogic-relationship-role>
<relationship-role-name>CountryRole</relationship-role-name>
<relationship-role-map>
<column-map>
<foreign-key-column>CAPITAL_NAME</foreign-key-column>
<key-column>NAME</key-column>
</column-map>
</relationship-role-map>
</weblogic-relationship-role>
</weblogic-rdbms-relation>
注意 : CAPITAL_NAME
は、Country テーブルの外部キーのカラム名です。
NAME
は、Capital テーブルの主キーのカラム名です。
<relationship-role-name> には、ejb-jar.xml
の <ejb-relationship-role
> スタンザの <cmr-field
> で指定された関連フィールドが入ります。
コード リスト 8-4 は、1 対多の関係を定義するサンプルの <weblogic-rdbms-relation> スタンザを示しています。
コード リスト 8-4 1 対多の関係の <weblogic-rdbms-relation> スタンザ
<weblogic-rdbms-relation>
<relation-name>OwnerDogRel</relation-name>
<weblogic-relationship-role>
<relationship-role-name>DogRole</relationship-role-name>
<relationship-role-map>
<column-map>
<foreign-key-column>OWNER_NAME</foreign-<key-column>
<key-column>NAME</key-column>
</column-map>
<relationship-role-map>
</weblogic-relationship-role>
</weblogic-rdbms-relation>
注意 : <relationship-role-name> には、ejb-jar.xml
の <ejb-relationship-role
> スタンザの <cmr-field
> で指定された関連フィールドが入ります。
<foreign-key-column> は、関係の「多」側のテーブルのカラムを指定する必要があります。
WebLogic Server の多対多の関係には、結合テーブルの物理的なマッピングが伴います。結合テーブルの各行には、関係に関与するエンティティの主キーに対応する 2 つの外部キーが格納されます。
次の例は、FRIENDS
Bean と EMPLOYEES
Bean の間の多対多の関係を示しています。
コード リスト 8-5 多対多の関係の <weblogic-rdbms-relation> スタンザ
<weblogic-rdbms-relation>
<relation-name>friends</relation-name>
<table-name>FRIENDS</table-name>
<weblogic-relationship-role>
<relationship-role-name>friend</relationship-role-name>
<relationship-role-map>
<column-map>
<foreign-key-column>first-friend-id</foreign-key-column>
<key-column>id</key-column>
</column-map
</relationship-role-map>
</weblogic-relationship-role>
<weblogic-relationship-role>
<relationship-role-name>second-friend</relationship-role-name>
<relationship-role-map>
<column-map>
<foreign-key-column>second-friend-id</foreign-key-column>
<key-column>id</key-column>
</column-map>
</relationship-role-map>
</weblogic-relationship-role>
</weblogic-rdbms-relation>
コード リスト 8-4 で、FRIENDS 結合テーブルには
first-friend-id および
second-friend-id という 2 つのカラムがあります。各カラムには、別の従業員の友人である特定の従業員を示す外部キーが格納されます。
EMPLOYEES
テーブルの主キー カラム (key-column
) は id
です。この例では、EMPLOYEES
Bean が 1 つのテーブルにマップされています。EMPLOYEES
Bean が複数のテーブルにマップされている場合、主キー カラム (key-column
) を格納するテーブルを relationship-role-map
で指定する必要があります。詳細については、「relationship-role-map」を参照してください。
weblogic-relationship-role
要素は、ejb-jar.xml
で指定された ejb-relationship-role
の以下の DBMS スキーマ情報を指定します。
relationship-role-map
サブ要素は、関係の片側の外部キーと主キーのマッピングを指定します。1 対 1 または 1 対多の関係の場合、関係の外部キー側のロールのみがマッピングを指定します。多対多の関係では、両方のロールがマッピングを指定します。詳細と例については、「relationship-role-map」を参照してください。 group-name
を使用すると、ロールに対応する Bean が関係を移動した (つまり cmr getXXX
メソッドを呼び出した) 結果としてロードされたときにロードされる field-group を示すことができます。 db-cascade-delete
タグを使用すると、カスケード削除が、基盤 DBMS の組み込みカスケード削除機能を使用するように指定できます。「詳細については、「db-cascade-delete」を参照してください。コンテナ管理による関係の詳細については、「コンテナ管理による関係 (CMR) の使用」を参照してください。
<weblogic-relationship-role>
<relationship-role-name>...</relationship-role-name>
<group-name> ....</group-name>
<relationship-role-map>...
....
</relationship-role-map>
<db-cascade-delete/>
</weblogic-relationship-role>