Cosminexus V9 BPM/ESB基盤 サービスプラットフォーム リファレンス

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

Message Queueアダプタ通信構成定義ファイル

形式

[図データ]

機能

Message Queueアダプタの通信定義をXML形式で設定します。通信定義には次の種類があります。

Message Queueアダプタ通信構成定義ファイルは次の手順で作成し,実行環境に反映してください。

  1. 次のテンプレートファイルを任意のディレクトリにコピーし,Message Queueアダプタ通信構成定義ファイルを定義します。
    <サービスプラットフォームのインストールディレクトリ>\CSC\custom-adapter\MQ\config\templates\adpmq_communication.xml
    編集後のファイルは任意のファイル名で保存してください。
  2. HCSC開発環境でパッケージングし,実行環境へインポートします。

作成したMessage Queueアダプタ通信構成定義ファイルのファイル名は,Message Queueアダプタ環境定義ファイルの<entry key="adpmq_deffile">要素の値として指定する必要があります。詳細については,「Message Queueアダプタ環境定義ファイル」を参照してください。

Message Queueアダプタ通信構成定義ファイルの定義内容を変更した場合は,手順2を実行して実行環境へインポートしてください。

設定できる要素

<?xml version="1.0" encoding="UTF-8"?>

このファイルがXMLファイルであることを示すXML宣言です。

<adaptermq_properties>

Message Queueアダプタ通信構成定義のルート要素です。

<res_ref_name> 〜<英数字,階層区切り文字>((1−255バイト))

リソースアダプタ特定情報を指定します。この要素の値には,アプリケーション統合属性ファイルの<hitachi-session-bean-property>に含まれる<res-ref-name>要素の内容と「jms/」を含めて同じ値を指定してください。指定は省略できません。

アプリケーション統合属性ファイルの指定値と合わせる定義項目については,アプリケーション統合属性ファイルの指定方法に従ってください。アプリケーション統合属性ファイルの指定方法は,マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション/リソース定義)」を参照してください。

<operation>

オペレーション要素です。この要素はオペレーションの数だけ定義できます。指定は省略できません。

<op_name> 〜<英数字>((1−256バイト))

オペレーション名を指定する要素です。この要素の値には,HCSC開発環境に指定するオペレーション名を指定してください。指定は省略できません。

<char_code> 〜{UTF8|UTF16_BIG|UTF16_LITTLE|MS932|JIS|KEIS+EBCDIC|KEIS+EBCDIK}<<UTF8>>

バイナリ入力形式のメッセージ送信要求電文またはメッセージ送受信要求電文に送信キュー特定情報および受信キュー特定情報を指定する場合,文字コードを指定します。指定は省略できます。

<send_operation>

メッセージ送信を指定する要素です。指定は省略できます。

メッセージ送信定義を設定する場合は必ず指定してください。

<receive_operation>

メッセージ受信を指定する要素です。指定は省略できます。

メッセージ受信定義を設定する場合は必ず指定してください。

<sndrcv_operation>

メッセージ送受信を指定する要素です。指定は省略できます。

メッセージ送受信定義を設定する場合は必ず指定してください。

<browse_operation>

ブラウズ・メッセージ受信を指定する要素です。指定は省略できます。

ブラウズ・メッセージ受信定義を設定する場合は必ず指定してください。

<res_name> 〜<英数字,階層区切り文字>((1−255バイト))<<要求電文設定情報>>

送信キュー特定情報または受信キュー特定情報を指定します。この要素の値には,アプリケーション統合属性ファイルの<hitachi-session-bean-property>に含まれる<resource-env-ref-name>要素内容と同じ値を指定してください。

要求電文で送信キュー特定情報または受信キュー特定情報を指定する場合は,指定を省略できます。

アプリケーション統合属性ファイルの指定値と合わせる定義項目については,アプリケーション統合属性ファイルの指定方法に従ってください。アプリケーション統合属性ファイルの指定方法は,マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション/リソース定義)」を参照してください。

<res_inf>

メッセージ送受信要求を実行する場合,送信キュー特定情報(<snd_res_name>)および受信キュー特定情報(<rcv_res_name>)要素を指定します。指定は省略できます。

指定する場合は,送信キュー特定情報と受信キュー特定情報の両方を指定してください。一方だけは指定できません。

<snd_res_name> 〜<英数字,階層区切り文字>((1−255バイト))<<要求電文設定情報>>

送信キュー特定情報を指定します。この要素の値には,アプリケーション統合属性ファイルの<hitachi-session-bean-property>に含まれる<resource-env-ref-name>要素内容と同じ値を指定してください。

要求電文で送信キュー特定情報を指定する場合は,指定を省略できます。

アプリケーション統合属性ファイルの指定値と合わせる定義項目については,アプリケーション統合属性ファイルの指定方法に従ってください。アプリケーション統合属性ファイルの指定方法は,マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション/リソース定義)」を参照してください。

<rcv_res_name> 〜<英数字,階層区切り文字>((1−255バイト))<<要求電文設定情報>>

受信キュー特定情報を指定します。この要素の値には,アプリケーション統合属性ファイルの<hitachi-session-bean-property>に含まれる<resource-env-ref-name>要素と同じ値を指定してください。

要求電文で受信キュー特定情報を指定する場合は,指定を省略できます。

アプリケーション統合属性ファイルの指定値と合わせる定義項目については,アプリケーション統合属性ファイルの指定方法に従ってください。アプリケーション統合属性ファイルの指定方法は,マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション/リソース定義)」を参照してください。

<id_type> 〜{Type1 | Type2}<<Type1>>

メッセージ相関識別子を設定するかどうかを次の中から指定します。指定は省略できます。

メッセージ送信要求の場合と,ブラウズ・メッセージ受信またはメッセージ受信要求の場合とで,次のように動作が異なります。

メッセージ送信要求の場合 メッセージ受信またはブラウズ・メッセージ受信要求の場合
Type1 メッセージ相関識別子を設定しないでメッセージを送信します。 メッセージ相関識別子を設定しないでメッセージを受信します。
Type2 JMSCorrelationIDにメッセージ相関識別子を設定してメッセージを送信します。メッセージ識別子はMessage Queueアダプタが自動的に生成します。 ユーザ指定のメッセージ識別子(CorrelationID)を設定してメッセージを受信します。

<message_type> 〜{BytesMessage | TextMessage}<<BytesMessage>>

送信用メッセージタイプを指定します。指定は省略できます。

<JMSDeliveryMode> 〜{PERSISTENT | NONPERSISTENT}<<PERSISTENT>>

送信メッセージの永続性の有無を指定します。指定は省略できます。

<JMSExpiration> 〜<数字>((0−65535000))<<0>>

送信メッセージ送信時の保持時間をミリ秒単位で指定します。指定は省略できます。

指定を省略するか0を指定した場合,メッセージが取得されるまで送信キューに保持し続けます。

なお,1秒未満の時間を指定すると,0ミリ秒と解釈される場合があります。JMSプロバイダの仕様を確認してください。

<JMSType> 〜<英数字>

メッセージタイプを指定します。この要素の値に,送受信するメッセージを特定するメッセージタイプを指定してください。指定は省略できます。

リソースアダプタのQueueプロパティのtargetClient指定に「MQ」を指定した場合,この指定は有効となりません。

<JMSCorrelID_PFX> 〜<英数字>((1−6バイト))

メッセージ相関識別子(CorrelationID)のプリフィックスを指定します。指定は省略できます。

この要素の値には,メッセージ相関識別子のプリフィックスを指定してください。この要素の値は,メッセージ送信要求またはメッセージ送受信要求で,<id_type>要素が「Type2」の場合に有効となります。

<receive_timeout> 〜<数字>((1000−65535000))<<180000>>

メッセージ応答監視時間をミリ秒単位で指定します。指定は省略できます。

この要素の値には,メッセージの受信が完了するまでの時間を指定します。この要素の値の時間内にメッセージを受信できない場合は,Fault応答情報が返ります。

記述例

要素の指定値を省略する場合は,各要素の開始タグおよび終了タグを含めて省略してください。開始タグおよび終了タグだけを記述しても,値の省略やタグ内の定義順序の変更はできません。

正しい記述方法

  :
<JMSExpiration>0</JMSExpiration>
<JMSDeliveryMode>PERSISTENT</JMSDeliveryMode>
  :

誤った記述方法(<JMSDeliveryMode>の指定値がない)

  :
<JMSExpiration>0</JMSExpiration>
<JMSDeliveryMode></JMSDeliveryMode>
  :