Web サービスのコンシューム

Web Service Consumer (WSC) コネクタの設定を作成したら、設定したサービスから SOAP 操作のコンシュームを開始できます。(Web サービスコンシューマの設定をまだ作成していない場合は、「Web サービスコンシューマの設定ドキュメント」を参照してください)。

WSC Connector には、Consume (wsc:consume) という操作が 1 つ含まれています。この操作の重要な 2 つのパラメータは、Operation (operation) と Message (wsc:message) です。

Consume 操作の基本構文は次のとおりです。

基本的な Consume 操作の例
<wsc:consume config-ref="config" operation="clients-list">
    <wsc:message>
        <wsc:body>#[payload]</wsc:body>
    </wsc:message>
</wsc:consume>

SOAP メッセージのディスパッチで問題が発生したら、WSC:CANNOT_DISPATCH エラーを受信します。

Operation パラメータ

operation パラメータは、Web サービスのどの SOAP 操作を呼び出すかを定義します。デザインタイムでは、operation パラメータは consume 操作の入力と出力のタイプを定義します。タイプは選択する操作によって異なります。

Message パラメータ

message パラメータは、Body、Headers、Attachments という 3 つの要素で構成される SOAP:ENVELOP の表現です。これらの要素はすべて省略可能です。

Body

body はメッセージの主要部分です。SOAP メッセージの最終的なエンドポイントに向けられた SOAP メッセージが含まれています。このパラメータは常に XML アプリケーション固有の要素です。

body 要素は埋め込まれた DataWeave スクリプトを値として受け入れるので、メッセージへの副作用がなく、または要求を作成するために複数のコンポーネントを使用する必要がなく、XML 要求を作成できます。デフォルトでは、メッセージの body の値は #[payload] です。つまり、デフォルトで、受信ペイロードはサービスへの送信準備が整った XML エンティティであることが予期されます。

body 要素内の変換の例を次に示します。

body パラメータ内の DataWeave 表現
<wsc:consume config-ref="config" operation="addClients">
    <wsc:message>
        <wsc:body>
        #[
        %dw 2.0
        output application/xml
        ns con http://service.soap.clients.namespace/
        ---
        con#clients: {
            client: {
                name: "Natasha",
                lastname: "Ferrari"
            },
            client: {
                name: "Lucas",
                lastname: "Barzola"
            }
        }]
        </wsc:body>
    </wsc:message>
</wsc:consume>

body が有効な XML でない場合、または何らかの理由で要求を作成できない場合、WSC:BAD_REQUEST エラーが発生します。

body のコンテンツが指定されていない場合、Web サービスコンシューマはコンテンツの生成を試みます。これは、body 内で XML エンティティが予期されない場合にのみ機能します。

ヘッダー

省略可能な headers 要素には、SOAP メッセージに関するアプリケーション固有の情報 (認証や支払いなど) が含まれます。body 要素と同様に、この要素は XML エンティティであり、DataWeave スクリプトをその値として埋め込むことができます。

headers パラメータ内の DataWeave 表現
<wsc:consume config-ref="config" operation="addClients">
    <wsc:message>
        <wsc:body>#[payload]</wsc:body>
        <wsc:headers>
          #[
          %dw 2.0
          output application/xml
          ns con http://service.soap.clients.namespace/
          ---
          "headers": {
              con#user: "NahuelMonin",
              con#pass: "%M4g\/iT0Rn4!"
          }]
        </wsc:header>
    </wsc:message>
</wsc:consume>

Anypoint Studio では、[Web Service Consumer Consume (Web サービスコンシューマのコンシューム)] 操作をキャンバスにドラッグした後、Web サービスコンシューマのプロパティを使用して、[Headers (ヘッダー)] 項目で SOAP ヘッダーを指定できます。

SOAP ヘッダーの設定についての詳細は、Mulesoft フォーラムのhttps://forums.mulesoft.com/questions/97338/how-to-set-soap-headers-in-web-service-consumer-in.html[「How to set SOAP headers in Web Service Consumer in Mule 4 (Mule 4 の Web サービスコンシューマで SOAP ヘッダーを設定する方法)」]を参照してください。

Attachments

attachments 要素を使用して、SOAP メッセージに添付ファイルをバインドすることができます。SOAP を使用するトランスポート用の添付ファイルを作成するには、DataWeave スクリプトを宣言する必要があります。このスクリプトの各エントリは添付ファイルを表し、その値で添付ファイルの内容を指定します。次に例を示します。

attachments パラメータ内の DataWeave 表現
<wsc:consume config-ref="config" operation="addClients">
    <wsc:message>
        <wsc:body>#[payload]</wsc:body>
        <wsc:attachments>
          #[{ clientsJson: vars.jsonFile } ]
        </wsc:attachments>
    </wsc:message>
</wsc:consume>

この例では、clientsJson という新しい添付ファイルを宣言し、そのコンテンツは jsonFile という変数に保存されています。この変数は、たとえば file:read 操作から設定することができます。

出力

Consume 操作の出力は、message パラメータで使用するのと同じ要素を含む受信 SOAP メッセージを表し、各部分にアクセスすることができます。

例を挙げます。

body パラメータ内の DataWeave 表現
<flow name="output">
  <wsc:consume config-ref="config" operation="addClients">
      <wsc:message>
          <wsc:body>#[payload]</wsc:body>
      </wsc:message>
  </wsc:consume>
  <set-variable name="soap.body" value="#[payload.body]">
  <set-variable name="soap.auth.header" value="#[payload.headers.auth]">
  <set-variable name="soap.attachment.json" value="#[payload.attachments.json]">
</flow>

この例では、soap.body という新しい変数に本文のコンテンツが保存されています。soap.auth.header 変数に auth というヘッダーが、soap.attachment.json という変数に json という添付ファイルの内容がそれぞれ保存されています。

属性

Web サービス操作をコンシュームするとき、応答のコンテンツだけではなく、メッセージのディスパッチに使用された基になるトランスポートのメタデータも把握したい場合があります。たとえば、HTTP を使用する場合、属性には HTTP 要求にバインドされている HTTP ヘッダーが含まれます (content-lengthstatus など)。

Web サービスコンシューマは、Mule メッセージの属性を使用してこの情報にアクセスします。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub