Cosminexus V9 アプリケーションサーバ リファレンス 定義編(アプリケーション/リソース定義)

[目次][索引][前へ][次へ]

2.2.4 Entity Bean属性の詳細

cosminexus.xmlのEntity Bean属性の詳細について,タグごとに説明します。

なお,ここでは,「2.1 アプリケーション属性ファイル(cosminexus.xml)の指定内容」に記載されている順番にタグの詳細について説明しています。

<この項の構成>
(1) <entity>
(2) <ejb-name>
(3) <security-identity>
(4) <run-as>
(5) <user-name>
(6) <resource-ref>
(7) <res-ref-name>
(8) <linked-to>
(9) <resource-env-ref>
(10) <resource-env-ref-name>
(11) <linked-queue>
(12) <resource-adapter>
(13) <queue>
(14) <linked-adminobject>
(15) <resourceadapter-name>
(16) <adminobject-name>
(17) <linked-to>
(18) <lookup-name>
(19) <optional-name>
(20) <local-optional-name>
(21) <maximum-instances>
(22) <pooled-instance>
(23) <minimum>
(24) <maximum>
(25) <caching-model>
(26) <entity-timeout>
(27) <pass-by-reference>
(28) <instance-timeout>
(29) <front-ejb>
(30) <cmp-map>
(31) <datasource-name>
(32) <catalog-name>
(33) <schema-name>
(34) <table-name>
(35) <read-only-access>
(36) <transaction-isolation>
(37) <concurrency-protection>
(38) <field-impl>
(39) <field-name>
(40) <column-name>
(41) <finder-impl>
(42) <method-name>
(43) <where-clause>
(44) <start-order>
(45) <ejb-method-observation-timeout>
(46) <method>
(47) <method-intf>
(48) <method-name>
(49) <method-params>
(50) <method-param>
(51) <method-observation-timeout>
(52) <ejb-transaction-timeout>
(53) <method>
(54) <method-intf>
(55) <method-name>
(56) <method-params>
(57) <method-param>
(58) <transaction-timeout>

(1) <entity>

説明
Entity Beanについて定義します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(2) <ejb-name>

説明
ejbの名称を指定します。
なお,このキーはEntity Beanを特定するためのキーとなります。
ejb-jar.xmlの<ejb-jar>-<enterprise-beans>-<entity>-<ejb-name>の設定値を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(3) <security-identity>

説明
Entity Beanのセキュリティアイデンティティを定義します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(4) <run-as>

説明
実行時アイデンティティを定義します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(5) <user-name>

説明
ユーザ名を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(6) <resource-ref>

説明
EntityBeanから参照するリソースを定義します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(7) <res-ref-name>

説明
リソース参照の名称を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(8) <linked-to>

説明
対応するリソースアダプタ表示名,メール表示名を指定します。
クラスタコネクションプールのメンバリソースアダプタは指定できません。
  • Connector 1.0以前
    <リソースアダプタの表示名>
  • Connector 1.5以降のアウトバウンドリソースアダプタ
    <リソースアダプタ表示名>!<コネクション定義識別子>

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できます。

(9) <resource-env-ref>

説明
Entity Beanから参照するリソース環境変数を定義します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(10) <resource-env-ref-name>

説明
resource-env-refの名称を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(11) <linked-queue>

説明
キュー名称を指定します。
このタグはDDの<resource-env-ref-type>に「javax.jms.Queue」が指定された場合だけ有効です。
なお,<linked-to>タグ,<linked-queue>タグ,<linked-adminobject>タグのうちどれか一つを指定します。

指定可能値
なし。

ほかのタグとの依存関係
DDの<resource-env-ref-type>タグと依存関係があります。

タグの省略
省略できます。

値の省略
省略できません。

(12) <resource-adapter>

説明
リソースアダプタの表示名を指定します。
Connector 1.5以降のリソースアダプタは指定できません。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(13) <queue>

説明
キュー名称を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(14) <linked-adminobject>

説明
管理対象オブジェクトを指定します。
なお,<linked-to>タグ,<linked-queue>タグ,<linked-adminobject>タグのうちどれか一つを指定します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(15) <resourceadapter-name>

説明
リソースアダプタの表示名を指定します。
Connector 1.0以前のリソースアダプタは指定できません。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(16) <adminobject-name>

説明
管理対象オブジェクト名を指定します。

指定可能値
英数字(0〜9,A〜Z,a〜z),および次の特殊文字を使用できます。
スペース( ),エクスクラメーションマーク(!),ダブルクォーテーション("),シャープ(#),ドル記号($),パーセント(%),アンパサンド(&),シングルクォーテーション('),バーレン(()()),アスタリスク(*),プラス(+),コンマ(,),ハイフン(-),ピリオド(.),コロン(:),セミコロン(;),レスザン(<),イコール(=),グレーターザン(>),クエスチョン(?),単価記号(@),ブラケット([)(]),円マーク(\),キャレット(^),アンダースコア(_),バッククォート(`),ブレイス({)(}),ストローク(|),チルダ(~)
ただし,次に示す名前は指定できません。
  • 先頭または末尾にピリオド(.)を付けた名前
  • ピリオド(.)だけの名前
  • アンダースコア(_)が連続している名前

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(17) <linked-to>

説明
JavaBeansリソースの表示名を指定します。
DDの要素<resource-env-ref-type>に「JavaBeansリソースのクラス名」が指定された場合だけ有効です。
なお,<linked-to>タグ,<linked-queue>タグ,<linked-adminobject>タグのうちどれか一つを指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
DDの<resource-env-ref-type>タグと依存関係があります。

タグの省略
省略できます。

値の省略
省略できます。

(18) <lookup-name>

説明
クライアントからEJBをルックアップする時に使う名前を指定します。HITACHI_EJB/SERVERS/<サーバ名>/EJB/<アプリケーションのルックアップ名>/<EJBのルックアップ名>の<EJBのルックアップ名>に相当します。
このタグを省略した場合,デフォルト値としてリソース名が使用されますが,デフォルト値に含まれる英数字とアンダースコア(_)以外の文字はすべてアンダースコアに変換されます。

指定可能値
英数字(0〜9,A〜Z,a〜z),および次の特殊文字を使用できます。
スペース( ),ダブルクォーテーション("),ドル記号($),パーセント(%),アンパサンド(&),シングルクォーテーション('),バーレン(()()),アスタリスク(*),プラス(+),コンマ(,),ハイフン(-),ピリオド(.),コロン(:),セミコロン(;),レスザン(<),イコール(=),グレーターザン(>),クエスチョン(?),単価記号(@),ブラケット([)(]),円マーク(\),キャレット(^),アンダースコア(_),バッククォート(`),ブレイス({)(}),ストローク(|),チルダ(~)
ただし,次に示す名前は指定できません。
  • 先頭または末尾にピリオド(.)を付けた名前
  • ピリオド(.)だけの名前
文字列の先頭または末尾に,半角スペースや改行がある場合,取り除かれて設定されます。また,文字列の途中に改行がある場合はエラーとなります。
指定できる文字数は1〜255文字です。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(19) <optional-name>

説明
リモートインタフェースの別名を指定します。

指定可能値
英数字(0〜9,A〜Z,a〜z),および次の特殊文字を使用できます。
スペース( ),エクスクラメーションマーク(!),ダブルクォーテーション("),シャープ(#),ドル記号($),パーセント(%),アンパサンド(&),シングルクォーテーション('),バーレン(()()),アスタリスク(*),プラス(+),コンマ(,),ハイフン(-),ピリオド(.),スラッシュ(/),コロン(:),セミコロン(;),レスザン(<),イコール(=),グレーターザン(>),クエスチョン(?),単価記号(@),ブラケット([)(]),円マーク(\),キャレット(^),アンダースコア(_),バッククォート(`),ブレイス({)(}),ストローク(|),チルダ(~)
ただし,次の名前は指定できません。
  • 予約語のHITACHI_EJB(大文字・小文字を区別します)で始まる名前
  • 先頭または末尾に,スラッシュ(/)またはピリオド(.)を指定した名前
  • スラッシュ(/)が連続している名前
文字列の先頭または末尾に,半角スペースや改行がある場合,取り除かれて設定されます。また,文字列の途中に改行がある場合はエラーとなります。
指定できる文字数は1〜255文字です。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(20) <local-optional-name>

説明
ローカルインタフェースの別名を指定します。

指定可能値
指定できる文字に制限はありません。
指定できる字数は1〜255文字です。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(21) <maximum-instances>

説明
Enterprise Beanインスタンスの最大数を指定します。

指定可能値
0(無制限)または1≦maximum-instances≦2147483647の整数値。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(22) <pooled-instance>

説明
インスタンスプールのプロパティを指定します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(23) <minimum>

説明
プール内のインスタンスの最小数を指定します。

指定可能値
0(無制限)または1≦minimum≦maximum。

ほかのタグとの依存関係
DDの<maximum>タグと依存関係があります。

タグの省略
省略できます。

値の省略
省略できません。

(24) <maximum>

説明
プール内のインスタンスの最大数を指定します。

指定可能値
maximum-instancesが0(無制限)の場合
0(無制限)≦maximum≦2147483647の整数値。
maximum-instancesが0(無制限)以外の場合
1≦maximum≦maximum-instancesの整数値。

ほかのタグとの依存関係
<maximum-instances>タグと依存関係があります。

タグの省略
省略できます。

値の省略
省略できません。

(25) <caching-model>

説明
キャッシングモデルを指定します。

指定可能値
  • full-caching
    メソッド起動間のすべての状態情報をキャッシュします。
  • caching
    メソッド起動間で最も頻繁に使用された状態情報をキャッシュします。
  • no-caching
    状態情報をキャッシュしません。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(26) <entity-timeout>

説明
EJBオブジェクトの存在時間(秒)を指定します。
0を指定した場合,タイムアウトしません。

指定可能値
0〜2147483647の整数値。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(27) <pass-by-reference>

説明
pass-by-referenceでのEJB呼び出しをするかどうかを指定します。

指定可能値
  • true
    EJB呼び出しをする。
  • false
    EJB呼び出しをしない。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(28) <instance-timeout>

説明
インスタンス取得タイムアウト時間(秒)を指定します。0を指定した場合,タイムアウトしません。

指定可能値
0〜86400の整数値。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(29) <front-ejb>

説明
フロントEJB(クライアントが直接呼び出すEJB)かどうかを指定します。

指定可能値
  • true
    フロントEJBの場合。
  • false
    フロントEJBでない場合。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(30) <cmp-map>

説明
Entity Beanのフィールドをデータベース上にマッピングします。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(31) <datasource-name>

説明
Enterprise Beanフィールドのマッピング先として開始されたリソースアダプタの表示名を指定します。
  • Connector 1.0以前
    <リソースアダプタの表示名>
  • Connector 1.5以降のアウトバウンドリソースアダプタ
    <リソースアダプタ表示名>!<コネクション定義識別子>

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(32) <catalog-name>

説明
Enterprise Beanフィールドのマッピング先としてデータベースのカタログ名を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(33) <schema-name>

説明
Enterprise Beanフィールドのマッピング先としてデータベースのスキーマ名を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(34) <table-name>

説明
Enterprise Beanフィールドのマッピング先としてデータベースのテーブル名を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(35) <read-only-access>

説明
アプリケーションからデータベースへの書き込みを禁止するかどうかを指定します。ただし,アプリケーションサーバでは指定しても無効になります。

指定可能値
  • true
    書き込みを禁止する。
  • false
    書き込みを許可する。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(36) <transaction-isolation>

説明
トランザクション遮断レベルを指定します。
省略した場合,デフォルトのトランザクション遮断レベルが使われます(使用するデータベースおよびJDBCドライバによって異なります)。

指定可能値
  • none
    トランザクションがサポートされていません。
  • read_committed
    ダーティー読み取りが抑制されます。
  • read_uncommitted
    ダーティー読み取り,繰り返し不可の読み取り,およびファントム読み取りが起こります。
  • repeatable_read
    ダーティー読み取りおよび繰り返し不可の読み取りが抑制されます。
  • serializable
    ダーティー読み取り,繰り返し不可の読み取り,およびファントム読み取りが抑制されます。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(37) <concurrency-protection>

説明
データベースに書き込むデータとレコードとの照合方法を指定します。

指定可能値
  • primary-key
    プライマリキーと照合することによってデータを更新します。
  • modified-data
    プライマリキーと照合して変更対象のデータの値が最後の読み出し操作以降に変更されているかどうかをチェックします。
  • whole-row
    プライマリキーと照合して変更対象の値を含む行内のすべての値が最後の読み出し操作以降に変更されているかどうかをチェックします。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(38) <field-impl>

説明
Entity Beanのフィールドとテーブルのカラムとのマッピングを指定します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(39) <field-name>

説明
Entity Beanのフィールド名を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(40) <column-name>

説明
テーブルのカラム名を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(41) <finder-impl>

説明
ejbFindByPrimaryKey以外のFinderメソッドの検索条件を指定します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(42) <method-name>

説明
Finderメソッドのメソッド名を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(43) <where-clause>

説明
テーブルの検索条件を指定します。
検索条件に指定可能な演算子を次に示します。
なお,山括弧<>は,XMLの構文上値には指定できません。テキストエディタで属性ファイルを編集する場合は,表内の丸括弧()のようにエンティティを使用してください。
演算子 説明 備考
IS NULL NULLである
IS NOT NULL NULLでない
= 等しい Finderメソッドのパラメタが1個以上のとき使用可
!= 等しくない
< (&lt;) 〜より小さい
> (&gt;) 〜より大きい
<= (&lt;=) 〜以下
>= (&gt;=) 〜以上
LIKE 検索パターンに一致する
NOT LIKE 検索パターンに一致しない
BETWEEN 範囲に含まれる Finderメソッドのパラメタが2個以上のとき使用可
NOT BETWEEN 範囲に含まれない

(凡例)−:該当なし。


検索条件の構文を次に示します。
  • IS NULL,IS NOT NULL演算子を使用する場合
    フィールド名 演算子
  • BETWEEN,NOT BETWEEN演算子を使用する場合
    フィールド名 演算子 ?番号 AND ?番号
  • そのほかの演算子を使用する場合
    フィールド名 演算子 ?番号
検索条件に関する規則を次に示します。
  • 検索条件は,ANDまたはORで接続できます。
  • 検索条件,AND,OR,フィールド名は大文字小文字を区別します。
  • ?番号には,Finderメソッドの引数の場所(左から1,2,...)を指定します。
    例 id &lt;= ?1 AND value IS NOT NULL OR name BETWEEN ?3 AND ?4
  • 検索条件,AND,OR,フィールド名,?番号の間は1文字以上の空白を入れてください。
  • 空文字列の場合は,テーブルのすべての行が検索パターンに一致するものと見なします。
  • DISABLEが指定されている場合はアプリケーションからこのメソッドを使用できません。

指定可能値
指定できる値はシャープ「#」以外です。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できます。

(44) <start-order>

説明
J2EEアプリケーション開始時・停止時の順番を指定します。開始時は昇順で開始処理が行われ,終了時は降順に停止処理が行われます。

指定可能値
0〜2147483647の整数値。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(45) <ejb-method-observation-timeout>

説明
EJBメソッドにJ2EEアプリケーションの実行時間の監視機能のメソッドタイムアウト時間を設定する場合に指定します。<ejb-method-observation-timeout>タグの指定が複数あり,<method>タグ以下の設定値が同じ場合,一つにマージされます。その場合,ワーニングメッセージ(KDJE42377-W)が出力され,先に定義された<ejb-method-observation-timeout>タグの<method-observation-timeout>タグの値が有効となります。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(46) <method>

説明
メソッドについて定義します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(47) <method-intf>

説明
メソッドが属するインタフェース種別を特定する場合に指定します。

指定可能値
  • Home
  • Remote
  • LocalHome
  • Local

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(48) <method-name>

説明
対象となるメソッド名を指定します。
アスタリスク「*」を指定した場合はすべてのメソッドを意味します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
<method-params>タグと依存関係があります。

タグの省略
省略できません。

値の省略
省略できません。

(49) <method-params>

説明
メソッドが多重定義されている場合,メソッドを特定するために指定します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できます。

(50) <method-param>

説明
引数のデータ型を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(51) <method-observation-timeout>

説明
J2EEアプリケーションの実行時間の監視機能のメソッドタイムアウト時間(秒)を指定します。0を指定した場合,タイムアウトしません。

指定可能値
0〜86400の整数値。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(52) <ejb-transaction-timeout>

説明
EJB(CMT)のメソッドにトランザクションタイムアウト時間を設定する場合に指定します。
<ejb-transaction-timeout>タグの指定が複数あり,<method>タグ以下の設定値が同じ場合,一つにマージされます。その場合,ワーニングメッセージ(KDJE42377-W)が出力され,先に定義された<ejb-transaction-timeout>タグの<transaction-timeout>タグの値が有効となります。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(53) <method>

説明
メソッドについて定義します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。

(54) <method-intf>

説明
メソッドが属するインタフェース種別を特定する場合に指定します。

指定可能値
  • Home
  • Remote
  • LocalHome
  • Local

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(55) <method-name>

説明
対象となるメソッド名を指定します。
アスタリスク「*」を指定した場合はすべてのメソッドを意味します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
<method-params>タグと依存関係があります。

タグの省略
省略できません。

値の省略
省略できません。

(56) <method-params>

説明
メソッドが多重定義されている場合,メソッドを特定するために指定します。

指定可能値
なし。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できます。

(57) <method-param>

説明
引数のデータ型を指定します。

指定可能値
入力は制限されません。

ほかのタグとの依存関係
なし。

タグの省略
省略できます。

値の省略
省略できません。

(58) <transaction-timeout>

説明
トランザクションタイムアウト時間(秒)を指定します。
0を指定した場合は,J2EEサーバに設定されたデフォルトのタイムアウト値で動作します。

指定可能値
0〜2147483647の整数値。

ほかのタグとの依存関係
なし。

タグの省略
省略できません。

値の省略
省略できません。