XML Soap

• SOAPは、S imple O bject A ccess Protocolの略です。
• SOAPはアプリケーション通信プロトコルです
• SOAPは、メッセージを送受信するための形式です。
• SOAPはプラットフォームに依存しません
• SOAPはXMLに基づいています
• SOAPはW3C勧告です

なぜSOAPなのか？

Webアプリケーションがインターネットを介して通信できることが重要です。

HTTPはすべてのインターネットブラウザとサーバーでサポートされているため、アプリケーション間で通信するための最良の方法はHTTPを介することです。これを実現するためにSOAPが作成されました。

SOAPは、さまざまなテクノロジーとプログラミング言語を使用して、さまざまなオペレーティングシステムで実行されているアプリケーション間で通信する方法を提供します。

SOAPビルディングブロック

SOAPメッセージは、次の要素を含む通常のXMLドキュメントです。

• XMLドキュメントをSOAPメッセージとして識別するエンベロープ要素
• ヘッダー情報を含むヘッダー要素
• 呼び出しおよび応答情報を含むBody要素
• エラーとステータス情報を含む障害要素

上記のすべての要素は、SOAPエンベロープのデフォルトの名前空間で宣言されています。

http://www.w3.org/2003/05/soap-envelope/

また、SOAPエンコーディングとデータ型のデフォルトの名前空間は次のとおりです。

http://www.w3.org/2003/05/soap-encoding

構文規則

重要な構文規則は次のとおりです。

• SOAPメッセージはXMLを使用してエンコードする必要があります
• SOAPメッセージはSOAPEnvelope名前空間を使用する必要があります
• SOAPメッセージにはDTD参照を含めることはできません
• SOAPメッセージにはXML処理命令を含めることはできません

スケルトンSOAPメッセージ

SOAPエンベロープ要素

必要なSOAPEnvelope要素は、SOAPメッセージのルート要素です。この要素は、XMLドキュメントをSOAPメッセージとして定義します。

例

xmlns：soap名前空間

上記の例のxmlns：soap名前空間に注意してください。常に「http://www.w3.org/2003/05/soap-envelope/」の値を持つ必要があります。

名前空間は、エンベロープをSOAPエンベロープとして定義します。

別の名前空間が使用されている場合、アプリケーションはエラーを生成し、メッセージを破棄します。

encodingStyle属性

encodingStyle属性は、ドキュメントで使用されるデータ型を定義するために使用されます。この属性は任意のSOAP要素に表示される可能性があり、要素のコンテンツとすべての子要素に適用されます。

SOAPメッセージにはデフォルトのエンコーディングはありません。

構文

例

SOAPヘッダー要素

オプションのSOAPヘッダー要素には、SOAPメッセージに関するアプリケーション固有の情報（認証、支払いなど）が含まれています。

Header要素が存在する場合、それはEnvelope要素の最初の子要素である必要があります。

注： Header要素のすべての直接の子要素は、名前空間で修飾されている必要があります。

上記の例には、「Trans」要素、値1の「mustUnderstand」属性、および値234のヘッダーが含まれています。

SOAPは、デフォルトの名前空間に3つの属性を定義します。これらの属性は、mustUnderstand、actor、およびencodingStyleです。

SOAPヘッダーで定義された属性は、受信者がSOAPメッセージを処理する方法を定義します。

mustUnderstand属性

SOAP mustUnderstand属性を使用して、受信者が処理するヘッダーエントリが必須かオプションかを示すことができます。

mustUnderstand = "1"をHeader要素の子要素に追加すると、Headerを処理するレシーバーが要素を認識しなければならないことを示します。受信者が要素を認識しない場合、ヘッダーの処理時に失敗します。

構文

例

アクター属性

SOAPメッセージは、メッセージパスに沿ってさまざまなエンドポイントを渡すことにより、送信者から受信者に移動する場合があります。ただし、SOAPメッセージのすべての部分が最終的なエンドポイントを対象としているわけではなく、メッセージパス上の1つ以上のエンドポイントを対象としている場合があります。

SOAPアクター属性は、Header要素を特定のエンドポイントにアドレス指定するために使用されます。

構文

例

encodingStyle属性

encodingStyle属性は、ドキュメントで使用されるデータ型を定義するために使用されます。この属性は任意のSOAP要素に表示される可能性があり、その要素のコンテンツとすべての子要素に適用されます。

SOAPメッセージにはデフォルトのエンコーディングはありません。

構文

SOAPボディ要素

必要なSOAPBody要素には、メッセージの最終エンドポイントを対象とした実際のSOAPメッセージが含まれています。

SOAP Body要素の直接の子要素は、名前空間で修飾されている場合があります。

例

上記の例では、リンゴの価格を要求しています。上記のm：GetPrice要素とItem要素は、アプリケーション固有の要素であることに注意してください。それらはSOAP名前空間の一部ではありません。

SOAP応答は次のようになります。

SOAP障害要素

オプションのSOAPFault要素は、エラーメッセージを示すために使用されます。

SOAP Fault要素は、SOAPメッセージのエラーとステータス情報を保持します。

Fault要素が存在する場合は、Body要素の子要素として表示される必要があります。障害要素は、SOAPメッセージに1回だけ表示されます。

SOAP障害要素には、次のサブ要素があります。

SOAP障害コード

以下に定義されているフォールトコード値は、フォールトを記述するときにフォールトコード要素で使用する必要があります。

HTTPプロトコル

HTTPはTCP / IPを介して通信します。HTTPクライアントは、TCPを使用してHTTPサーバーに接続します。接続を確立した後、クライアントはHTTP要求メッセージをサーバーに送信できます。

次に、サーバーは要求を処理し、HTTP応答をクライアントに送り返します。応答には、要求のステータスを示すステータスコードが含まれています。

上記の例では、サーバーは200のステータスコードを返しました。これはHTTPの標準の成功コードです。

サーバーがリクエストをデコードできなかった場合は、次のようなものが返されている可能性があります。

SOAPバインディング

SOAP仕様は、SOAPメッセージの交換方法ではなく、SOAPメッセージの構造を定義します。このギャップは、いわゆる「SOAPバインディング」によって埋められます。SOAPバインディングは、トランスポートプロトコルを使用してSOAPメッセージを効果的に交換できるようにするメカニズムです。

ほとんどのSOAP実装は、HTTPやSMTPなどの一般的なトランスポートプロトコルのバインディングを提供します。

HTTPは同期的であり、広く使用されています。SOAP HTTPリクエストは、少なくとも2つのHTTPヘッダー（Content-TypeとContent-Length）を指定します。

SMTPは非同期であり、最後の手段または特定の場合に使用されます。

SOAPのJava実装は通常、JMS（Javaメッセージングシステム）プロトコルに特定のバインディングを提供します。

コンテンツタイプ

SOAP要求および応答のContent-Typeヘッダーは、メッセージのMIMEタイプと、要求または応答のXML本文に使用される文字エンコード（オプション）を定義します。

構文

例

コンテンツの長さ

SOAP要求および応答のContent-Lengthヘッダーは、要求または応答の本文のバイト数を指定します。

構文

例

SOAPの例

以下の例では、GetStockPriceリクエストがサーバーに送信されます。リクエストには、StockNameパラメータと、レスポンスで返されるPriceパラメータがあります。関数の名前空間は「http://www.example.org/stock」で定義されています。

SOAPリクエスト：

SOAP応答：