3.3.9　Message Queueアダプタを定義する

(a)　要求電文

Message Queueアダプタの呼び出し元から，送信キューへのメッセージ送信および受信キューからのメッセージ受信の実行を要求するための電文を要求電文といいます。

要求電文として送信する情報を説明します。

キュー操作情報

キュー操作情報はキューにアクセスするために必要な情報です。キュー操作情報の内容を次に示します。

表3‒37　キュー操作情報

情報	説明
送信キュー特定情報，受信キュー特定情報	アクセスする送信キューまたは受信キューを指定します。アプリケーション統合属性ファイルの<resource-env-ref>タグ内にある<resource-env-ref-name>タグで指定したresource-env-refの名称を指定します。
メッセージ相関識別子	メッセージ受信要求またはブラウズ・メッセージ受信要求時，メッセージ相関識別子と一致するメッセージを受信する場合に指定します。指定値は24バイト以内でメッセージ送信応答時に設定されるメッセージ相関識別子を指定します。メッセージ相関識別子のフォーマットについては，マニュアル「サービスプラットフォーム 解説」の「2.10.2　Message Queueアダプタを使ったメッセージキューへのアクセス」のメッセージ相関識別子の生成方法に関する説明を参照してください。

送信メッセージ

XML形式またはバイナリ形式メッセージを送信要求する場合に要求電文に指定するユーザデータです。

(b)　要求電文の内容

要求電文の内容は，送信キュー特定情報および受信キュー特定情報の有無やメッセージ相関識別子の指定有無および送信メッセージ形式（バイナリ形式またはXML形式）のうち，必要な情報だけを電文に記述します。

●メッセージ送信要求の場合

XML形式で送信キュー特定情報を指定する場合の要求電文形式を次に示します。

表3‒38　XML形式の送信要求電文形式（送信先キュー特定情報指定あり）

情報	電文内のタグ名	指定値	必須
ルート要素	SendRequest	−	○
ヘッダ情報	mqheader	−	○
送信キュー特定情報	sndresname	送信キュー特定情報※	○
送信メッセージ	userdata	ユーザ任意	○

XML形式で送信キュー特定情報を指定しない場合の要求電文形式を次に示します。

表3‒39　XML形式の送信要求電文形式（送信先キュー特定情報指定なし）

情報	電文内のタグ名	指定値	必須
ルート要素	SendRequest	−	○
ヘッダ情報	mqheader	−	○
送信メッセージ	userdata	ユーザ任意	○

バイナリ形式で送信キュー特定情報を指定する場合について説明します。

バイナリメッセージを送信する場合は，要求電文がバイナリ形式になります。バイナリ形式の要求電文の構造を次に示します。

図3‒17　バイナリ形式の送信要求電文の構造

電文の全体長は次の関係式が成り立つ必要があります。

LL ≧ 10 + Ln

バイナリメッセージを送信する場合に，要求電文に必要な情報を次に示します。

表3‒40　バイナリ形式の送信要求電文形式（送信先キュー特定情報指定あり）

情報	電文内のタグ名	指定値	必須
送信キュー特定情報長	送信キュー特定情報のバイト長を10進数文字列で指定	10バイト	○
送信キュー特定情報	送信キュー特定情報（文字列）	任意	○
送信メッセージ	ユーザ任意	任意	○

バイナリ形式で送信キュー特定情報を指定しない場合の要求電文形式を次に示します。

表3‒41　バイナリ形式の送信要求電文形式（送信先キュー特定情報指定なし）

情報	電文内のタグ名	指定値	必須
送信メッセージ	ユーザ任意	任意	○

●メッセージ受信要求の場合

バイナリ形式のメッセージ受信要求は指定できません。

XML形式のメッセージ受信要求電文形式を次に示します。

表3‒42　XML形式のメッセージ受信要求電文形式

情報	電文内のタグ名	指定値	必須
ルート要素	RecvRequest	−	○
ヘッダ情報	mqheader	−	○
受信キュー特定情報	rcvresname	受信キュー特定情報※1	×
メッセージ相関識別子	correlationid	受信メッセージの相関識別子※2	×

●ブラウズ・メッセージ受信要求の場合

バイナリ形式のブラウズ・メッセージ受信要求は指定できません。

XML形式のブラウズ・メッセージ受信要求電文形式を次に示します。

表3‒43　XML形式のブラウズ・メッセージ受信要求電文形式

情報	電文内のタグ名	指定値	必須
ルート要素	BrowseRequest	−	○
ヘッダ情報	mqheader	−	○
受信キュー特定情報	rcvresname	受信キュー特定情報※1	×
メッセージ相関識別子	correlationid	受信メッセージの相関識別子※2	×

●メッセージ送受信要求の場合

XML形式の送信キュー特定情報および受信キュー特定情報を指定する場合の要求電文形式を次に示します。

表3‒44　XML形式のメッセージ送受信要求電文形式（送受信キュー特定情報指定あり）

情報	電文内のタグ名	指定値	必須
ルート要素	SndRcvRequest	−	○
ヘッダ情報	mqheader	−	○
送信キュー特定情報	sndresname	送信キュー特定情報※	○
受信キュー特定情報	rcvresname	受信キュー特定情報※	○
送信メッセージ	userdata	任意	○

XML形式の送信キュー特定情報および受信キュー特定情報を指定しない場合の要求電文形式を次に示します。

表3‒45　XML形式のメッセージ送受信要求電文形式（送受信キュー特定情報指定なし）

情報	電文内のタグ名	指定値	必須
ルート要素	SndRcvRequest	−	○
ヘッダ情報	mqheader	−	○
送信メッセージ	userdata	任意	○

バイナリ形式の送信キュー／受信キュー特定情報を指定する場合について説明します。

バイナリメッセージを送受信する場合は，要求電文がバイナリ形式になります。バイナリ形式の要求電文の構造を次に示します。

図3‒18　バイナリ形式の送受信要求電文の構造

電文の全体長は次のような関係式が成り立つ必要があります。

LL ≧ 10 + Ln + 10 + Lo

バイナリメッセージを送受信する場合に，要求電文に必要な情報を次に示します。

表3‒46　バイナリ形式の送信要求電文形式（送信先キュー/受信キュー特定情報指定あり）

情報	電文内のタグ名	指定値	必須
送信キュー特定情報長	送信キュー特定情報のバイト長を10進数文字列で指定	10バイト	○
送信キュー特定情報	送信キュー特定情報（文字列）	任意	○
受信キュー特定情報長	受信キュー特定情報のバイト長を10進数文字列で指定	10バイト	○
受信キュー特定情報	受信キュー特定情報（文字列）	任意	○
送信メッセージ	ユーザ任意	任意	○

バイナリ形式の送信キュー／受信キュー特定情報を指定しない場合の要求電文形式を次に示します。

表3‒47　バイナリ形式の送信要求電文形式（送信先キュー／受信キュー特定情報指定なし）

情報	電文内のタグ名	指定値	必須
送信メッセージ	ユーザ任意	任意	○

(c)　応答電文

Message Queueアダプタの呼び出し元へ返却する電文を応答電文といいます。応答電文として返される情報を説明します。

受信メッセージ

XML形式，またはバイナリ形式のメッセージを受信する場合，応答電文に格納されるユーザデータです。

メッセージ送信結果

XML形式，またはバイナリ形式のメッセージを送信する場合，送信処理の結果が応答電文へ格納されます。送信処理が失敗した場合，Message Queueアダプタはカスタムアダプタ開発フレームワークへ例外を通知し応答電文は返しません。応答電文にメッセージ送信結果が格納されるのは，メッセージ送信が成功したときだけとなります。このため，メッセージ送信時の応答電文の返却値は必ず「OK」になります。

メッセージ相関識別子

XML形式，またはバイナリ形式のメッセージの送信時，JMSCorrelationIDヘッダフィールドに設定したメッセージ相関識別子です。

(d)　応答電文の内容

応答電文の内容は，受信メッセージ形式（バイナリ形式またはXML形式）によって異なります。

なお，バイナリ形式のメッセージ送信応答は指定できません。

XML形式の送信応答電文形式を次に示します。

●メッセージ送信要求の応答電文の場合

XML形式の送信応答電文形式を次に示します。

表3‒48　XML形式の送信応答電文形式

情報	電文内のタグ名	返却値
ルート要素	SendResponse	−
メッセージ送信結果	status	OK
メッセージ相関識別子	correlationid	メッセージ相関識別子※

●メッセージ受信要求の応答電文の場合

XML形式のメッセージ受信応答電文形式を次に示します。

表3‒49　XML形式のメッセージ受信応答電文形式

情報	電文内のタグ名	返却値
受信メッセージ	ユーザ任意	ユーザ任意

バイナリ形式のメッセージ受信応答電文形式を次に示します。

表3‒50　バイナリ形式のメッセージ受信応答電文形式

情報	電文内のタグ名
受信メッセージ	ユーザ任意

●ブラウズ・メッセージ受信要求の応答電文の場合

XML形式のブラウズ・メッセージ受信応答電文形式を次に示します。

表3‒51　XML形式のブラウズ・メッセージ受信応答電文形式

情報	電文内のタグ名	返却値
受信メッセージ	ユーザ任意	ユーザ任意

バイナリ形式のブラウズ・メッセージ受信応答電文形式を次に示します。

表3‒52　バイナリ形式のブラウズ・メッセージ受信応答電文形式

情報	電文内のタグ名
受信メッセージ	ユーザ任意

●メッセージ送受信要求の応答電文

XML形式のメッセージ送受信応答電文形式を次に示します。

表3‒53　XML形式のメッセージ送受信応答電文形式

情報	電文内のタグ名	返却値
受信メッセージ	ユーザ任意	ユーザ任意

バイナリ形式のメッセージ送受信応答電文形式を次に示します。

表3‒54　バイナリ形式のメッセージ送受信応答電文形式

情報	電文内のタグ名
受信メッセージ	ユーザ任意

(e)　フォーマット定義ファイルの作成

各電文フォーマットのうち，サービス部品項目に設定する電文フォーマットがMessage Queueアダプタの電文フォーマットです。Message Queueアダプタの電文フォーマットの作成方法を説明します。

XML形式の要求電文

要求電文用のXMLフォーマット定義ファイルは，テンプレートファイルを使用して作成するか，製品提供ファイルを使用します。それ以外の場合はユーザが独自に作成してください。

XMLフォーマット定義テンプレートファイルを使用する場合

• メッセージの送信要求電文で送信キューを指定します。

• メッセージの送受信要求で送信キューおよび受信キューを指定します。

製品提供ファイルを使用する場合

• メッセージの受信要求電文で受信キューおよびメッセージ相関識別子を指定します。

• ブラウズ・メッセージ受信要求で受信キューおよびメッセージ相関識別子を指定します。

ユーザが独自に作成する場合

上記，XMLフォーマット定義テンプレートファイルを使用する場合にも製品提供ファイルを使用する場合にも該当しない場合は，ユーザが独自に作成してください。

XMLフォーマット定義テンプレートファイルとカスタマイズの説明を次に示します。

図3‒19　メッセージ送信要求電文用テンプレートファイル（adpmq_snd_request.xsd）

表3‒55　メッセージ送信要求電文用テンプレートファイルの内容

行数	説明
4行目	このテンプレートファイルの名前空間宣言を表します。ユーザは6行目に指定したtargetNamespace属性の値に任意の接頭辞を宣言します。
6行目	このテンプレートファイルの対象名前空間を表します。ユーザはtargetNamespace属性の値に一意となる対象名前空間を指定します。
8行目	25行目でユーザデータ用のXMLスキーマ情報をインポートする場合，5行目にインポートするスキーマのターゲットネームスペースを，8行目にインポートするスキーマのインポート文を記述します。
10〜16行目	SendRequest要素宣言を表します。要求電文のルート要素となる。mqheader要素とuserdata要素を持ちます。ユーザはmqheader要素とuserdata要素の接頭辞として4行目で宣言した接頭辞を記述します。
18〜22行目	mqheader要素宣言を表します。
24行目	userdata要素宣言を表します。
25行目	ユーザデータ用のXMLスキーマ情報を記述します。 記述方法 記述方法は2種類あり，このファイルに直接記述する方法と，ユーザデータ用のXMLスキーマ情報を記述するファイルを別に作成し，このファイルからインポートする方法があります。インポートする場合は5行目にインポートするスキーマのターゲットネームスペースを，8行目にインポートするスキーマのインポート文を記述します。 注意事項 ユーザデータ用のXMLスキーマ情報を記述する際，userdata要素の子要素には複数の要素を宣言してはいけません。userdata要素の子要素はXMLファイル出力時にルート要素となる要素であるため，userdata要素の子要素は必ず1つだけ宣言してください。

図3‒20　メッセージ送受信要求電文用フォーマット定義テンプレートファイル（adpmq_sndrcv_request.xsd）

表3‒56　メッセージ送受信要求電文用テンプレートファイルの内容

行数	説明
4行目	このテンプレートファイルの名前空間宣言を表します。ユーザは6行目に指定したtargetNamespace属性の値に任意の接頭辞を宣言します。
6行目	このテンプレートファイルの対象名前空間を表します。ユーザはtargetNamespace属性の値に一意となる対象名前空間を指定します。
8行目	26行目でユーザデータ用のXMLスキーマ情報をインポートする場合，5行目にインポートするスキーマのターゲットネームスペースを，8行目にインポートするスキーマのインポート文を記述します。
10〜16行目	SndRcvRequest要素宣言を表します。要求電文のルート要素となるmqheader要素とuserdata要素を持ちます。ユーザはmqheader要素とuserdata要素の接頭辞として4行目で宣言した接頭辞を記述します。
18〜23行目	mqheader要素宣言を表します。
21行目	受信キュー特定情報の指定要素を表します。この指定個所がメッセージ送信要求用テンプレートファイルと異なります。
25行目	userdata要素宣言を表します。
26行目	ユーザデータ用のXMLスキーマ情報を記述します。 記述方法 記述方法は2種類あり，このファイルに直接記述する方法と，ユーザデータ用のXMLスキーマ情報を記述するファイルを別に作成し，このファイルからインポートする方法があります。インポートする場合は5行目にインポートするスキーマのターゲットネームスペースを，8行目にインポートするスキーマのインポート文を記述します。 注意事項 ユーザデータ用のXMLスキーマ情報を記述する際，userdata要素の子要素には複数の要素を宣言してはいけません。userdata要素の子要素はXMLファイル出力時にルート要素となる要素であるため，userdata要素の子要素は必ず１つの要素しか宣言できません。

XML形式の応答電文

応答電文用のXMLフォーマット定義ファイルは，製品提供のフォーマット定義ファイルを使用するか，ユーザが独自に作成してください。

製品提供ファイルを使用する場合

次の条件に当てはまるときに使用します。

• メッセージ送信応答するとき。

• メッセージ受信応答，ブラウズ・メッセージ受信応答またはメッセージ送受信応答でFault応答情報電文を受信するとき。

ユーザが独自に作成する場合

上記，製品提供ファイルを使用する場合に該当しない場合は，ユーザが独自に作成してください。

バイナリ形式の要求電文

要求電文用のバイナリフォーマット定義ファイルは，製品提供のテンプレートファイルを使用してユーザがバイナリフォーマット定義画面で編集するか，ユーザが独自に作成してください。

バイナリフォーマット定義テンプレートファイルを使用する場合

• メッセージの送信要求電文で送信キュー特定情報を指定するとき。

• メッセージ送受信要求で送信キュー特定情報および受信キュー特定情報を指定するとき。

ユーザが独自に作成する場合

上記，製品提供ファイルを使用する場合に該当しない場合は，ユーザが独自に作成してください。

バイナリ形式の応答電文

応答電文用バイナリフォーマット定義ファイルは次のケースがありますが，ユーザが独自に作成してください。

• メッセージ受信応答でバイナリメッセージを受信する。

• ブラウズ・メッセージ受信応答でバイナリメッセージを受信する。

• メッセージ送受信応答でバイナリメッセージを受信する。

(a)　編集手順

アプリケーション統合属性ファイルの編集手順を示します。

1. サービスアダプタ定義画面（詳細）の［独自定義ファイル］で「cscadapter_property.xml」を選択し，［編集］ボタンをクリックします。

   アプリケーション統合属性ファイルを編集するためのエディタが起動します。

2. エディタ上でアプリケーション統合属性ファイルを編集します。

   設定内容については「(b) 定義詳細」を参照してください。

3. Eclipseのメニューから［ファイル］−［保存］を選択し，定義内容を保存します。

(b)　定義詳細

アプリケーション統合属性ファイルの内容を次に示します。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hitachi-application-all-property PUBLIC 
'-//Hitachi, Ltd.//DTD Application All Property 7.6//EN' 'http://localhost/hitachi-application-all-property_7_6.dtd'>
<!-- All Rights Reserved. Copyright (C) 2008, Hitachi, Ltd. -->
 
<hitachi-application-all-property>
  <hitachi-application-property>
    <lookup-name>CSCMQ</lookup-name>
    <security-prop>
      <security-method>no_security_for_methods_without_roles</security-method>
    </security-prop>
    <managed-by-ctm>false</managed-by-ctm>
  </hitachi-application-property>
  <ejb-jar>
    <hitachi-ejb-jar-property>
      <display-name>CSCMsgServiceAdapter</display-name>
    </hitachi-ejb-jar-property>
    <hitachi-session-bean-property>
      <display-name>CSCMsgServiceAdapterEJB</display-name>
      <session-type>Stateless</session-type>
      <transaction-type>Container</transaction-type>
      <resource-ref>
        <res-ref-name>jms/リソースアダプタ特定情報</res-ref-name>
        <res-type>javax.jms.QueueConnectionFactory</res-type>
        <res-auth>Container</res-auth>
        <res-sharing-scope>Unshareable</res-sharing-scope>
        <linked-to>リソースアダプタ表示名</linked-to>
      </resource-ref>
      <resource-env-ref>
        <resource-env-ref-name>送信キュー特定情報または受信キュー特定情報</resource-env-ref-name>
        <resource-env-ref-type>javax.jms.Queue</resource-env-ref-type>
        <linked-adminobject>
          <resourceadapter-name>リソースアダプタ表示名</resourceadapter-name>
          <adminobject-name>管理対象オブジェクト名</adminobject-name>
        </linked-adminobject>
      </resource-env-ref>
      <container-transaction>
        <description></description>
        <method>
          <description></description>
          <method-intf></method-intf>
          <method-name>*</method-name>
        </method>
        <trans-attribute>Required</trans-attribute>
      </container-transaction>
      <session-runtime>
        <lookup-name>CSCMsgServiceAdapterEJB</lookup-name>
        <optional-name></optional-name>
        <maximum-sessions>0</maximum-sessions>
        <stateless>
          <pooled-instance>
            <minimum>インスタンス最小数</minimum>
            <maximum>インスタンス最大数</maximum>
          </pooled-instance>
        </stateless> 
      </session-runtime>
   </hitachi-session-bean-property>
  </ejb-jar>
</hitachi-application-all-property>

定義の設定値について説明します。

●アプリケーション属性<hitachi-application-property>

<lookup-name>

クライアントからEJBをルックアップするときに使う名前として「CSCMQ」を指定します。

<security-method>

セキュリティの管理方法として「no_security_for_methods_without_roles」を指定します。

<managed-by-ctm>

CTMの連帯として「false（CTMと連携しない）」を指定します。

●EJB-JAR属性<hitachi-ejb-jar-property>

<display-name>

EJB-JARの表示名として「CSCMsgServiceAdapter」を指定します。

●Session Bean属性<hitachi-session-bean-property>

<display-name>

Session Beanの表示名として「CSCMsgServiceAdapterEJB」を指定します。

<session-type>

Session Beanの種別として「Stateless」を指定します。

<transaction-type>

トランザクション管理種別として「Container」を指定します。

<res-ref-name>

リソースアダプタ特定情報を指定します。この指定値はリソースアダプタを特定する任意の名称を指定します。指定するときは先頭に「jms/」を付与してください。

この要素と同一の指定値をMessage Queueアダプタ通信構成定義の<res_ref_name>要素に設定してください。

<res-type>

リソース種別を指定します。参照先リソースアダプタのコネクション定義識別子（<connectionfactory-interface>タグの設定値）として「javax.QueueConnectionFactory」を指定します。

<res-auth>

認証方式として「Container」を指定します。

<res-sharing-scope>

参照したリソースアダプタ共有有無の指定として「Unshareable」を指定します。

<linked-to>

参照するリソースアダプタの表示名を指定します。

Outboundリソースアダプタは，<リソースアダプタ表示名>!<コネクション定義識別子>で指定します。

<コネクション定義識別子>とは，リソースアダプタのデプロイ・ディスクリプター（ra.xml）の<connectionfactory-interface>タグで指定した値のことです。

<res-env-ref-name>

送信キュー特定情報または受信キュー特定情報を指定します。この指定値は接続先キューを特定する任意の名称を指定します。指定するときは先頭に「jms/」を付与してください。

この要素と同一の指定値をMessage Queueアダプタ通信構成定義の<res_name>，<snd_res_name>，または<rcv_res_name>要素に設定してください。

<res-env-ref-type>

リソース環境変数の値のクラスタイプの指定として「javax.jms.Queue」を指定します。

<resourceadapter-name>

リソース環境変数のリソースアダプタの表示名を指定します。

<adminobject-name>

管理対象オブジェクト名を指定します。リソースアダプタのデプロイ・ディスクリプター（ra.xml）の<adminobject-name>と同一の値を指定します。

<trans-attribute>

メソッドに割り当てるトランザクション属性として「Required」を指定します。

<lookup-name>

クライアントからEJBをルックアップする場所に使用する名称として「CSCMsgServiceAdapterEJB」を指定します。

<maximum-sessions>

セッションの最大数として「0（無制限）」を指定します。

<minimum>

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

<maximum>

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

アプリケーション統合属性ファイルの詳細については，次の個所を参照してください。

• マニュアル「アプリケーションサーバ アプリケーション設定操作ガイド」の「9.2　アプリケーション統合属性ファイルによるプロパティ設定」

• マニュアル「アプリケーションサーバ リファレンス 定義編(アプリケーション／リソース定義)」の「3.1　アプリケーション統合属性ファイル」