SOAP Header要素


オプションの SOAP Header 要素にはヘッダー情報が含まれます。


SOAP Header 要素

オプションの SOAP Header 要素には、SOAP メッセージに関するアプリケーション固有の情報(認証、支払いなど)を含めることができます。

Header 要素が提供される場合、それは Envelope 要素の最初の子要素でなければなりません。

注意:すべての Header 要素の直接の子要素は、名前空間で修飾されていなければなりません。

<?xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

<soap:Header>
  <m:Trans xmlns:m="http://www.w3schools.com/transaction/"
  soap:mustUnderstand="1">234
  </m:Trans>
</soap:Header>
...
...
</soap:Envelope>

上記の例には、"Trans" 要素を持つヘッダーが含まれており、その値は 234 で、この要素の "mustUnderstand" 属性の値は "1" です。

SOAP はデフォルトの名前空間 ("http://www.w3.org/2001/12/soap-envelope") で 3 つの属性を定義しています。

これら 3 つの属性は、actor、mustUnderstand、encodingStyle です。SOAP ヘッダーに定義されたこれらの属性は、コンテナが SOAP メッセージをどのように処理するかを定義できます。


mustUnderstand 属性

SOAP の mustUnderstand 属性は、ヘッダー項目が、それを処理する受信者にとって必須であるかオプションであるかを識別するために使用できます。

Header 要素のいずれかの子要素に "mustUnderstand="1" を追加した場合、このヘッダーを処理する受信者がこの要素を理解しなければならないことを示すことができます。受信者がこの要素を理解できない場合、このヘッダーの処理は失敗しなければなりません。

構文

soap:mustUnderstand="0|1"

例

<?xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

<soap:Header>
  <m:Trans xmlns:m="http://www.w3schools.com/transaction/"
  soap:mustUnderstand="1">234
  </m:Trans>
</soap:Header>
...
...
</soap:Envelope>


actor 属性

SOAP メッセージは、メッセージパスに沿って異なるエンドポイントを経由することで、送信者から受信者へ伝搬されます。SOAP メッセージのすべての部分が最終エンドポイントに届けられることを意図されているわけではありませんが、メッセージパス上にある 1 つ以上のエンドポイントに届けられることを意図している場合もあります。

SOAP の actor 属性は、Header 要素を特定のエンドポイントにアドレス指定するために使用できます。

構文

soap:actor="URI"

例

<?xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

<soap:Header>
  <m:Trans xmlns:m="http://www.w3schools.com/transaction/"
  soap:actor="http://www.w3schools.com/appml/">234
  </m:Trans>
</soap:Header>
...
...
</soap:Envelope>


encodingStyle 属性

SOAP の encodingStyle 属性は、ドキュメント内で使用されるデータ型を定義するために使用されます。この属性は任意の SOAP 要素に出現でき、要素の内容とそのすべての子要素に適用されます。

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

構文

soap:encodingStyle="URI"

その他の拡張