3.6.1 MessageDrivenBean属性ファイルの指定内容

MessageDrivenBean属性ファイルは,次に示すDOCTYPE宣言を持ちます。

<!DOCTYPE hitachi-message-bean-property PUBLIC '-//Hitachi, Ltd.//DTD Message Bean Property 7.6//EN' 'file:///<Application Serverのインストールディレクトリ>/CC/admin/dtds/hitachi-message-bean-property_7_6.dtd'>

MessageDrivenBean属性ファイルは,次に示すタグを持つxmlファイルです。なお,属性ファイルのバージョンは,以前のバージョンのものでも使用できます。

タグ名の欄にあるマニュアルの参照先には,そのタグの関連情報があります。マニュアル名に「アプリケーションサーバ」と記載されたマニュアルについては,名称を省略しています。

タグ名出現パターン説明
<hitachi-message-bean-property>1回ルートタグ。
<description>※10回以上※2Message-driven Beanについての説明。







<display-name>※11回以上※2Message-driven Beanの名称。
xml:lang属性が"en"のdisplay-nameを必ず指定します。該当するリソースの表示名をコマンドの引数で指定する場合も,xml:lang属性が"en"のdisplay-nameを指定します。
1≦文字列長
指定できる文字の制限はありません。
文字列の先頭または末尾に,半角スペースがある場合,エラーとならずに,取り除かれて設定されます。

<icon>※10回以上※2GUIツール上に表示されるEntity Beanのアイコンの定義。
<small-icon>0または1回スモールアイコン(16×16)のファイル名。
<large-icon>0または1回ラージアイコン(32×32)のファイル名。




<messaging-type>0または1回Message-driven Beanのメッセージリスナインタフェース。
記述されていない場合には,"javax.jms.MessageListener"が仮定されます。
このタグは,EJB2.1以降のEnterprise Beanに対して指定できます。

<transaction-type>1回トランザクションの管理方法。
「Container」または「Bean」のどちらかを指定できます。


<activation-config>0または1回Message-driven Beanの動作環境。
このタグより下位のタグは,EJB2.1以降のEnterprise Beanに対して指定できます。
<description>※10回以上Message-driven Beanの動作環境の説明。

<activation-config-property>1回以上Message-driven Beanの動作環境に関するプロパティ。

 
<activation-config-property-name>1回Message-driven Beanの動作環境に関するプロパティ名。

 <activation-config-property-value>1回Message-driven Beanの動作環境に関するプロパティの値。

<message-selector>0または1回Message-driven beanが受信するメッセージを決定するためのJMSメッセージセレクタ。
このタグはEJB2.0以前のEnterprise Beanに対して指定できます。





<acknowledge-mode>0または1回BMTのMessage-driven beanのonMessageメッセージで使用する通知セマンティクス。
「Auto-acknowledge」または「Dups-ok-acknowledge」のどちらかを指定します。デフォルトは「Auto-acknowledge」です。
このタグはEJB2.0以前のEnterprise Beanに対して指定できます。

<message-driven-destination>0または1回JMSデスティネーションの定義。
このタグより下位のタグはEJB2.0以前のEnterprise Beanに対して指定できます。


<destination-type>1回JMSデスティネーションのタイプ。
「javax.jms.Queue」または「javax.jms.Topic」のどちらかを指定します。


<subscription-durability>0または1回JMSデスティネーションが「javax.jms.Topic」の場合のサブスクリプション。
「Durable」または「NonDurable」のどちらかを指定します。デフォルトは後者です。

<env-entry>0回以上Message-driven Beanから呼び出す環境変数についての定義。
<description>※10回以上※2環境変数についての説明。
<env-entry-name>1回環境変数の名称。




















<env-entry-type>1回環境変数の値のJavaタイプ。
指定できる値を次に示します。
  • java.lang.Boolean
  • java.lang.String
  • java.lang.Character
  • java.lang.Integer
  • java.lang.Double
  • java.lang.Byte
  • java.lang.Short
  • java.lang.Long
  • java.lang.Float
<env-entry-value>1回環境変数の値。


<ejb-ref>0回以上Message-driven Beanからリモートインタフェースを持つEnterprise Beanへの参照情報についての定義。
<description>※10回以上※2Enterprise Bean参照についての説明。
<ejb-ref-name>1回リンク先のEnterprise Beanの名称。






<ejb-ref-type>1回リンク先のEnterprise Beanの種別。
指定できる値を次に示します。
  • Session
  • Entity


<home>1回リンク先のEnterprise BeanのRemote Homeインタフェース名。


<remote>1回リンク先のEnterprise BeanのRemote Componentインタフェース名。




<ejb-link>0または1回リンク先のEnterprise Beanの名称。ネーミングの切り替え機能でリンク先を設定する場合,次の形式で指定してください。

corbaname::<名前空間のホスト名>:<名前空間のポート番号>#<EJBHomeオブジェクトリファレンスのJNDI名>



<ejb-local-ref>0回以上Message-driven Beanからローカルインタフェースを持つEnterprise Beanへの参照情報についての定義。
<description>※10回以上※2ejb-local-refの説明。
<ejb-ref-name>1回リンク先のEnterprise Beanの名称。






<ejb-ref-type>1回リンク先のEnterprise Beanの種別。
指定できる値を次に示します。
  • Session
  • Entity


<local-home>1回リンク先のEnterprise BeanのLocal Homeインタフェース名。


<local>1回リンク先のEnterprise BeanのLocal Componentインタフェース名。
<ejb-link>0または1回リンク先のEnterprise Beanの名称。


<message-ref>0または1回Connector1.0のリソースアダプタを指定する場合,<resource-adapter>と<queue>の組み合わせは,複数のアプリケーション間でユニークにする必要があります。
┃┃┣┃<connection-factory>0または1回リソースアダプタの表示名を指定します。
Connector1.5以降のリソースアダプタは指定できません。
<connection-destination>1回cjsetrespropでは無視されます。

 
<resource-adapter>1回リソースアダプタの表示名を指定します。
┃┃ <queue>0または1回キューの表示名を指定します。
Connector1.5以降のリソースアダプタは指定できません。
<security-identity>0または1回セキュリティアイデンティティについての定義。
<description>※10回以上※2security-identityの説明。
<run-as>1回実行時アイデンティティの定義。
 <description>※10回以上※2run-asの説明。
 <role-name>1回セキュリティロール名。
 <user-name>1回プリンシパル名。
<resource-ref>0回以上Message-Driven Beanから参照するリソースの定義。
<description>※10回以上※2resource-refの説明。
<res-ref-name>1回リソース参照の名称。
























<res-type>1回リソース種別。
指定可能な文字列は次のとおり。
  • javax.mail.Session
  • javax.sql.DataSource
  • javax.jms.QueueConnectionFactory
  • javax.jms.ConnectionFactory
  • javax.resource.cci.ConnectionFactory
  • org.omg.CORBA_2_3.ORB(DDで定義しなくてもlookupできるリソース)
  • javax.jms.TopicConnectionFactory
参照先がConnector1.5のリソースアダプタの場合,参照先リソースアダプタのコネクション定義識別子(<connectionfactory-interface>タグの設定値)を指定します。




<res-auth>1回リソースマネジャへ登録する方法。
指定できる値は,「Container」または「Application」のどちらかです。






<res-sharing-scope>0または1回リソースマネジャファクトリリファレンスから取得したコネクションを共有するかどうかの指定。
設定できる値は,「Shareable」または「Unshareable」のどちらかです。デフォルトは「Shareable」です。




<mapped-name>0または1回対応するリソースアダプタ表示名またはメール表示名。※3
<linked-to>タグと同時に指定した場合は,<linked-to>タグが有効となります。














<linked-to>0または1回対応するリソースアダプタ表示名,データソース表示名,またはメール表示名。
リソースアダプタ表示名の指定方法は,リソースアダプタのバージョンによって異なります。
Connector1.0以前
<リソースアダプタの表示名>
Connector1.5以降のOutboundリソースアダプタ
<リソースアダプタ表示名>!<コネクション定義識別子>
<コネクション定義識別子>とは,ra.xmlの<connectionfactory-interface>タグで指定した値のことです。
クラスタコネクションプールのメンバリソースアダプタは指定できません。
cjsetrespropでは無視されます。

<resource-env-ref>0回以上Message-driven Beanから参照するリソース環境変数の定義。
<description>※10回以上※2resource-env-refの説明。
<resource-env-ref-name>1回リソース環境変数参照の名称。












<resource-env-ref-type>1回リソース環境変数参照の種別。
次のJavaクラスまたはインタフェース名を指定します。
  • javax.jms.Queue
  • javax.jms.Topic
  • JavaBeansリソースのクラス名
<linked-adminobject>を指定した場合は,任意のクラス名が表示されます。
















<mapped-name>0または1回<resource-env-ref-type>が「javax.jms.Queue」の場合,対応するキュー※3を次の形式で表示します。
"<リソースアダプタの表示名>#<Queue名称>"
<linked-Queue>タグと同時に指定した場合は,<linked-Queue>タグが有効となります。
<resource-env-ref-type>が「JavaBeansリソースのクラス名」の場合,対応するJavaBeansリソースの表示名を表示します。<linked-to>タグと同時に指定した場合は,<linked-to>タグが有効となります。




<linked-queue>0または1回queue名称。
cjsetrespropでは無視されます。
<resource-env-ref-type>が「javax.jms.Queue」の場合だけ有効となります。



<resource-adapter>1回リソースアダプタの表示名を指定します。
Connector1.5のリソースアダプタは指定できません。
<queue>1回キューの表示名を指定します。




<linked-adminobject>
 
「機能解説 基本・開発編(コンテナ共通機能)」-「3.16」
0または1回管理対象オブジェクト。cjsetrespropでは無視されます。



<resourceadapter-name>1回リソースアダプタの表示名を指定します。
Connector1.0以前のリソースアダプタは指定できません。

┃┃
















┃┃















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

文字列の先頭または末尾に,半角スペースや改行がある場合,取り除かれて設定されます。



<linked-to>0または1回JavaBeansリソースの表示名。
<resource-env-ref-type>に「Java.jms.リソースのクラス名」が指定された場合だけ有効となります。
cjsetrespropでは無視されます。
<container-transaction>0回以上コンテナのトランザクションについての定義。
<description>※10回以上※2container-transactionの説明。
<method>1回以上メソッドについての定義。
<description>※10回以上※2メソッドの説明。






<method-intf>0または1回メソッドが属するインタフェース種別。
このタグには,値を指定できません。ただし,設定先がEJB2.0以前のEJBの場合は,"Bean"を指定できます。



<method-name>1回メソッド名。
*を指定した場合,すべてのメソッドを表します。※4










<method-params>0または1回method-nameが*以外の場合に有効。
method-paramsの指定あり
method-intfで指定したインタフェースにある,method-paramsで指定したパラメタを持つmethod-nameのメソッド。
method-paramsの指定なし
method-intfで指定したインタフェースにある,すべてのmethod-nameのメソッド。




















 <method-param>0回以上パラメタのデータ型。
プリミティブ型またはクラスの名称を指定します。
配列の場合は名称の後ろに[]を指定します(名称と[の間,[と]の間を空けないようにしてください)。多次元配列の場合は[]を続けて指定します(]と[の間を空けないようにしてください)。配列の内部形式名(int[]の場合[I,java.lang.String[]の場合[Ljava.lang.String;)は指定できません。

  • int
  • short[][]
  • java.lang.String[]






<trans-attribute>1回メソッドに割り当てるトランザクション属性。
指定できる文字列を次に示します。
  • Mandatory
  • Never
  • NotSupported
  • Required
  • RequiresNew
  • Supports


<runtime>0または1回
cjsetapppropで使用する場合
必須
cjsetrespropで使用する場合
無視されます。
<pooled-instance>1回プール内のインスタンスについての定義。



<minimum>
 
「機能解説 基本・開発編(EJBコンテナ)」-「2.9.3」
1回プール内のインスタンスの最小数。※3
1が表示されます。


<maximum>
 
「機能解説 基本・開発編(EJBコンテナ)」-「2.9.3」
1回プール内のインスタンスの最大数。
1≦maximum≦2147483647​。
0を指定した場合,1が設定されます。


<front-ejb>0または1回フロントEJB(クライアントが直接呼び出すEJB)かどうかを指定します。フロントEJBの場合はtrueを指定し,フロントEJBでない場合はfalseを指定します。デフォルト値はfalseです。


<start-order>0または1回J2EEアプリケーション開始時・停止時の順番を指定します。開始時は昇順で開始処理が行われ,終了時は降順に停止処理が行われます。
0≦start-order≦2147483647​


┃┃

┃┃
<ejb-method-observation-timeout>
 
「機能解説 運用/監視/連携編」-「5章」
0回以上EJBのメソッドに仕掛かり中メソッド監視用タイムアウト時間を設定する場合に指定します。
<ejb-method-observation-timeout>の指定が複数あり,<method>タグ以下の設定値(<description>タグを除く)が同じ場合,一つにマージされます。その場合,ワーニングメッセージ(KDJE37601-W)が出力され,先に定義された<ejb-method-observation-timeout>の<method-observation-timeout>の値が有効になります。
<method>1回以上
<description>0または1回メソッドの説明。このタグは複数指定できません。






<method-intf>0または1回メソッドが属するインタフェース種別。
このタグには,値を指定できません。ただし,設定先がEJB2.0以前のEJBの場合は,"Bean"を指定できます。



<method-name>1回対象となるメソッド名を指定します。*を指定した場合,すべてのメソッドを表します。※4


<method-params>0または1回メソッドが多重定義されている場合,メソッドを特定するために指定します。
 <method-param>0回以上引数のデータ型を指定。


<method-observation-timeout>1回仕掛かり中メソッド監視用タイムアウト時間を,0~86400(単位:秒)で指定します。0を指定した場合,タイムアウトしません。デフォルト値は0。
<ejb-transaction-timeout>
 
「機能解説 基本・開発編(コンテナ共通機能)」-「3.15.8」
0回以上EJB(CMT)のメソッドにトランザクションタイムアウト時間を設定する場合に指定します。
<ejb-transaction-timeout>の指定が複数あり,<method>タグ以下の設定値(<description>タグを除く)が同じ場合,一つにマージされます。その場合,ワーニングメッセージ(KDJE37601-W)が出力され,先に定義された<ejb-transaction-timeout>の<transaction-timeout>の値が有効になります。
 <method>1回以上
 <description>0または1回メソッドの説明。このタグは複数指定できません。
 





<method-intf>0または1回メソッドが属するインタフェース種別を特定する場合に指定します。
このタグには,値を指定できません。ただし,設定先がEJB2.0以前のEJBの場合は,"Bean"を指定できます。
 

<method-name>1回対象となるメソッド名を指定します。*を指定した場合はすべてのメソッドを表します。※4
 
<method-params>0または1回メソッドが多重定義されている場合,メソッドを特定するために指定します。
  <method-param>0回以上引数のデータ型を指定。
 <transaction-timeout>1回トランザクションタイムアウト時間を,0~2147483647​(単位:秒)で指定します。0を指定した場合,タイムアウトしません。デフォルト値は0。
注※1
xml:lang属性を指定できます。xml:lang属性を指定しない場合は,「en(英語)」が仮定されます。なお,xml:lang属性が同じタグを複数指定できません。
注※2
EJB2.0以前のEJBに対して,このタグを複数指定できません。
注※3
cjgetrespropコマンドで出力されたものに対し,タグ名の変更,タグの追加・削除,値の変更をしてはいけません。
注※4
サーバ管理コマンド用のusrconf.propertiesファイルのejbserver.cui.checkmethod.compatibleに「false」を指定している場合にこのタグで指定されたメソッドが存在しないとき,属性の設定でエラーになります。usrconf.propertiesファイルのejbserver.cui.checkmethod.compatibleキーについては,マニュアル「アプリケーションサーバ リファレンス 定義編(サーバ定義)」の「5.4 usrconf.properties(サーバ管理コマンド用システムプロパティファイル)」を参照してください。