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

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

2.2.3 Session Bean属性の詳細

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

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

<この項の構成>
(1) <session>
(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-sessions>
(22) <stateless>
(23) <pooled-instance>
(24) <minimum>
(25) <maximum>
(26) <instance-timeout>
(27) <stateful>
(28) <maximum-active-sessions>
(29) <inactivity-timeout>
(30) <removal-timeout>
(31) <enable-scheduling>
(32) <pass-by-reference>
(33) <scheduling>
(34) <queue-name>
(35) <parallel-count>
(36) <queue-length>
(37) <front-ejb>
(38) <start-order>
(39) <ejb-method-observation-timeout>
(40) <method>
(41) <method-intf>
(42) <method-name>
(43) <method-params>
(44) <method-param>
(45) <method-observation-timeout>
(46) <ejb-transaction-timeout>
(47) <method>
(48) <method-intf>
(49) <method-name>
(50) <method-params>
(51) <method-param>
(52) <transaction-timeout>

(1) <session>

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

指定可能値
なし。

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

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

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

(2) <ejb-name>

説明
ejbの名称を指定します。
なお,このキーはSession Beanを特定するためのキーとなります。
ejb-jar.xmlの<ejb-jar>-<enterprise-beans>-<session>-<ejb-name>の設定値を指定します。
ejb-jar.xmlを含まないアプリケーションの場合,@Stateless,@Stateful,または@Singletonのnameの設定値を指定します。
nameが指定されていない場合は,EJB実装クラス名のパッケージ名を取り除いたクラス名を指定します。

指定可能値
なし。

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

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

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

(3) <security-identity>

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

指定可能値
なし。

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

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

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

(4) <run-as>

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

指定可能値
なし。

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

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

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

(5) <user-name>

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

指定可能値
なし。

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

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

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

(6) <resource-ref>

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

指定可能値
なし。

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

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

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

(7) <res-ref-name>

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

指定可能値
なし。

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

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

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

(8) <linked-to>

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

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

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

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

値の省略
省略できます。

(9) <resource-env-ref>

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

指定可能値
なし。

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

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

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

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

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

指定可能値
なし。

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

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

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

(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>

説明
リソースアダプタの表示名を指定します。
Connector1.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-sessions>

説明
セッションの最大数またはBeanインスタンスの最大数を指定します。
Stateless Session BeanまたはSingleton Session Beanの場合,この設定値は無効になります。

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

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

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

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

(22) <stateless>

説明
Session Beanの種別がStatelessの場合に指定します。
<stateless>または<stateful>のどちらかを指定するか,またはどちらも指定しません。

指定可能値
なし。

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

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

値の省略
省略できます。

(23) <pooled-instance>

説明
プール内のインスタンスについて定義します。

指定可能値
なし。

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

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

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

(24) <minimum>

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

指定可能値
0または1≦minimum≦maximumの整数値。

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

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

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

(25) <maximum>

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

指定可能値
0(無制限)または1≦maximum≦2147483647の整数値。
また,<enable-scheduling>タグの値がtrue,かつアプリケーション属性<managed-by-ctm>タグの値がtrueの場合は,指定可能範囲が異なります。
  • アプリケーション属性の<scheduling-unit>タグの指定値がBeanの場合
    0または<scheduling>-<parallel-count>以上の整数値。
  • アプリケーション属性の<scheduling-unit>タグの指定値がApplicationの場合
    0またはアプリケーション属性<scheduling>-<parallel-count>タグ以上の整数値。

ほかのタグとの依存関係
<enable-scheduling>タグ,アプリケーション属性の<managed-by-ctm>タグ,アプリケーション属性の<scheduling-unit>タグ,<scheduling>-<parallel-count>タグ,およびアプリケーション属性の<scheduling>-<parallel-count>タグと依存関係があります。

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

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

(26) <instance-timeout>

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

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

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

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

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

(27) <stateful>

説明
Session Beanの種別がStatefulの場合に指定します。
<stateless>もしくは<stateful>のどちらかを指定するか,またはどちらも指定しません。

指定可能値
なし。

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

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

値の省略
省略できます。

(28) <maximum-active-sessions>

説明
アクティブセッションの最大数を指定します。

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

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

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

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

(29) <inactivity-timeout>

説明
再びアクティブ化するまでに非アクティブ状態に保持しておく時間(分)を指定します。

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

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

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

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

(30) <removal-timeout>

説明
セッションが削除されるまでに非アクティブ状態に保持しておく時間(分)を指定します。

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

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

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

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

(31) <enable-scheduling>

説明
該当するBeanをスケジューラのGateとして使用するかどうかを指定します。

指定可能値
  • true
    使用する。
  • false
    使用しない。

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

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

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

(32) <pass-by-reference>

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

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

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

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

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

(33) <scheduling>

説明
CTM連携関連の情報を設定します。

指定可能値
なし。

ほかのタグとの依存関係
DDの<session-type>タグ,<scheduling-unit>タグ,および<enable-scheduling>タグと依存関係があります。

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

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

(34) <queue-name>

説明
スケジューリングを実行するキュー名を指定します。

指定可能値
英数字,アンダースコア「_」を使用できます。
指定できる文字数は1〜63文字です。

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

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

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

(35) <parallel-count>

説明
CTMスケジューラがアプリケーションを呼ぶために用意するスレッド数を指定します。

指定可能値
1〜127の整数値。

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

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

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

(36) <queue-length>

説明
キューの長さを指定します。

指定可能値
1〜32767の整数値。

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

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

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

(37) <front-ejb>

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

指定可能値
  • true
    フロントEJBである。
  • false
    フロントEJBでない。

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

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

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

(38) <start-order>

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

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

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

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

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

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

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

指定可能値
なし。

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

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

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

(40) <method>

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

指定可能値
なし。

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

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

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

(41) <method-intf>

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

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

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

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

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

(42) <method-name>

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

指定可能値
なし。

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

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

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

(43) <method-params>

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

指定可能値
なし。

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

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

値の省略
省略できます。

(44) <method-param>

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

指定可能値
空白区切り文字,行区切り文字,および段落区切り文字以外を指定します。

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

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

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

(45) <method-observation-timeout>

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

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

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

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

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

(46) <ejb-transaction-timeout>

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

指定可能値
なし。

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

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

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

(47) <method>

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

指定可能値
なし。

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

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

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

(48) <method-intf>

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

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

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

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

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

(49) <method-name>

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

指定可能値
なし。

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

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

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

(50) <method-params>

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

指定可能値
なし。

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

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

値の省略
省略できます。

(51) <method-param>

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

指定可能値
なし。

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

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

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

(52) <transaction-timeout>

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

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

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

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

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