継承図

協調図

解説

SFXSOAPParser クラスは、 SFXXMLDOMParser クラスを継承し、 DOM 方式で SOAP メッセージ（SOAP Envelope）を解析します。

SOAP メッセージ（SOAP Envelope）について

SOAP によるオブジェクト間通信でやり取りされるデータ（SOAP メッセージ）は、 プロトコルバインディングヘッダーと SOAP Envelope から構成されます。 図 279. SOAP メッセージの構造 プロトコルバインディングヘッダーには、実装するプロトコル毎に定められているヘッダー情報が記述されます。 SOAP Envelope は、 Envelope 要素（<SOAP-ENV:Envelope>）をルート要素（最上位要素）とする XML 文書のことで、 SOAP Header と SOAP Body から構成されます。 SOAP Header と SOAP Body の最上位要素はそれぞれ <SOAP-ENV:Header> と <SOAP-ENV:Body> になります。 つまり、Envelope 要素は、Header 要素（SOAP Header）と Body 要素（SOAP Body）を子要素に持ちます。 SOAP Header には、SOAP メッセージの受信者が SOAP Body に記述された情報をどのサーバーに渡し、 どのように処理するかといった情報が記述されます。SOAP Header は、SOAP Envelope に無くても構いません。 SOAP Body には、実際のメッセージが記され、SOAP Envelope には必須です。 例えば、SOAP-RPC の場合、この部分には Web サービスのメソッド名やそのパラメータの情報が記述されます。

	Simple Object Access Protocol ( SOAP ) の仕様
	W3C SOAP 最新情報 : SOAP Version 1.2 Part 0: Primer (Second Edition) ( SOAP 1.1 と SOAP 1.2 をサポートしています。) ※ SOAP Attachment は実装されていません。また、SOAP Fault は SOAP 1.1 だけをサポートします。

<?xml version="1.0" encoding="UTF-8"?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" >
 <env:Header>
    <SubscriptionInfo xmlns="http://schemas.xmlsoap.org">
      <LicenseStatusCode>0</LicenseStatusCode>
      <LicenseStatus>Valid license key</LicenseStatus>
      <LicenseActionCode>0</LicenseActionCode>
      <LicenseAction>Decremented hit count</LicenseAction>
      <RemainingHits>18</RemainingHits>
      <Amount>0</Amount>
    </SubscriptionInfo>
 </env:Header>
 <env:Body>
  <m:GetLastTradePriceResponse 
        env:encodingStyle="http://www.w3.org/2003/05/soap-envelope"
        xmlns:m="http://example.org/2001/06/quotes">
   <Price>34.5</Price>
  </m:GetLastTradePriceResponse>
  <m:GetLastTradePriceResponse
        env:encodingStyle="http://www.w3.org/2003/05/soap-envelope"
        xmlns:m="http://example.org/2006/06/quotes">
   <Price>56.5</Price>
  </m:GetLastTradePriceResponse>
 </env:Body>
</env:Envelope>

SFXSOAPParser soapparser; // SOAP パーサー

// "soapmessage.xml" ファイルから SOAP メッセージを読み込み、解析する
if  (soapparser.Parse("soapmessage.xml") != SFERR_NO_ERROR) {

    // エラー値を表示する
    TRACE("error id = 0x%x", soapparser.static_catch());

    // エラーメッセージを表示する
    TRACE(soapparser.GetErrorInfo());

} else {
// SOAP メッセージ解析完了後の処理

    // SOAP メッセージのバージョンを表示する
    TRACE("soap version : %d", soapparser.GetSoapVersion());  
    // "soap version : 1" が表示される(SFXSOAPParser::SOAP_VERSION_1_2 なので)

    // Envelope 要素を取得する
    SFXXMLElementPtr envelope = soapparser.GetEnvelope();

    // Envelope 要素の名前空間を表示する
    TRACE("envelope version : %s", envelope->GetNamespaceURI());  
    // "envelope version: http://www.w3.org/2003/05/soap-envelope" が表示される

    // Header 要素を取得する
    SFXXMLElementPtr header = soapparser.GetHeader();
    // Header 要素の名前空間を表示する
    TRACE("header version : %s", header->GetNamespaceURI());  
    // "header version: http://www.w3.org/2003/05/soap-envelope" が表示される

    // Header 要素のすべての子要素を取得する
    SFXXMLNode::DOMNodeListPtr list = soapparser.GetHeaderEntries();

    // 要素数を表示する
    TRACE("entry number : %d", list->GetSize());  
    // "entry number : 1" が表示される(SFXSOAPParser::SOAP_VERSION_1_2)
    
    // Header 要素に含まれる "SubscriptionInfo" 要素を取得する
    SFXXMLElementPtr entry = soapparser.GetHeaderEntry("SubscriptionInfo", "http://schemas.xmlsoap.org");

    // "SubscriptionInfo" 要素のすべての子要素を取得する
    list = entry->GetChildNodes();

    // 列挙子を取得する
    SFXXMLNode::DOMNodeList::Enumerator childEtor = list->GetFirstEnumerator();

    while (childEtor.HasNext()) {

        SFXXMLElementPtr current = static_cast<SFXXMLElementPtr>(childEtor.GetNext());

        // 各要素の名前を表示する
        TRACE("current element name : %s", current->GetName()); 
        // "current element name : LicenseStatusCode" などが表示される

        // 各要素のテキストを表示する
        TRACE("current element content : %s", current->GetText().GetCString());  
        // "current element content : 0" などが表示される
     }

    // Body 要素を取得する
    SFXXMLElementPtr body = soapparser.GetBody();

    // Body 要素の名前空間を表示する
    TRACE("body version : %s", body->GetNamespaceURI());   
    // "body version : http://www.w3.org/2003/05/soap-envelope" が表示される

    // Body 要素のすべての子要素を取得する
    list = soapparser.GetBodyEntries();

    // 要素数を表示する
    TRACE("entry number: %d", list->GetSize());  
    // "2" が表示される
    
    // 列挙子を取得する
    childEtor = list->GetFirstEnumerator();

    while (childEtor.HasNext()) {

        SFXXMLElementPtr current = static_cast<SFXXMLElementPtr>(childEtor.GetNext());

        // 各要素内容を表示する
        TRACE("current element name : %s", current->GetLocalName());   
        // "current element name : GetLastTradePriceResponse" などが表示される

        // 各要素の名前空間を表示する
        TRACE("current element namespace : %s", current->GetNamespaceURI()); 
        // "current element namespace : http://example.org/2001/06/quotes" などが表示される

        // 各要素のテキスト(価格)を表示する
        TRACE("price : %s", current->GetText().GetCString());   
        // "price : 34.5" などが表示される
    }
}

参照

SFXXMLDOMParser

メンバ

解説

このコンストラクタは、SFXXMLDOMParser::SetDoNamespaces / SFXXMLDOMParser::SetCreateCommentNodes 関数を呼び出して名前空間を処理し、 コメントノードを生成しない設定にします。

参照

SFXXMLDOMParser::SetDoNamespaces | SFXXMLDOMParser::SetCreateCommentNodes

解説

この関数は、この XML パーサーが使用している、 すべての内部変数をリセットします。

	注意
	内部的に SFXSOAPParser::Reset 関数を呼び出します。

参照

SFXSOAPParser::Reset

戻り値

SOAP メッセージの Body 要素（Element ノード）

解説

この関数は、SOAP メッセージの Body 要素（SOAP Body）を取得します。

参照

SFXSOAPParser::GetEnvelope | SFXSOAPParser::GetHeader | SFXSOAPParser::GetBodyEntries | SFXSOAPParser::GetBodyEntry

戻り値

SOAP メッセージの Body 要素のすべての子要素（SFXXMLNode::DOMNodeList）

解説

この関数は、SOAP メッセージの Body 要素（SOAP Body）のすべての子要素を取得します。

SOAP メッセージの Body 要素（SOAP Body）のすべての子要素を SFXXMLNode::DOMNodeList へのポインタとして返します。

子要素がないときは null を返します。

参照

SFXXMLNode::DOMNodeList | SFXSOAPParser::GetBody | SFXSOAPParser::GetBodyEntry

戻り値

SOAP メッセージの Body 要素の指定された子要素（Element ノード）

解説

この関数は、SOAP メッセージの Body 要素（SOAP Body）の指定された子要素を取得します。

local 引数には要素のローカル名、uri 引数には要素の名前空間 URI を指定します。

	前提条件
	この関数を使用するには、 SFXXMLDOMParser::SetDoNamespaces 関数を使用して名前空間を処理する設定にする必要があります。

使用例

解析対象の XML 文書は SFXSOAPParser クラスの説明で記述されているものです。

SFXSOAPParser soapparser;   // SOAP パーサー
 
// GetBodyEntry 関数で最新の価格を取得する
// この要素ポインタは 1 番目の "GetLastTradePriceResponse" 要素を指す
SFXXMLElementPtr price = soapparser.GetBodyEntry("GetLastTradePriceResponse", "http://example.org/2006/06/quotes");

// 価格を表示する
/// price : 56.5
TRACE("price : %s", price->GetText().GetCString());  

参照

SFXXMLDOMParser::SetDoNamespaces | SFXSOAPParser::GetBody | SFXSOAPParser::GetBodyEntries

戻り値

SOAP メッセージの Envelope 要素（Element ノード）

解説

この関数は、SOAP メッセージの Envelope 要素（SOAP Envelope）を取得します。

参照

SFXSOAPParser::GetHeader | SFXSOAPParser::GetBody

戻り値

SOAP メッセージの Fault 要素（Element ノード）

解説

この関数は、SOAP メッセージの Fault 要素（SOAP Fault）を取得します。

SOAP Fault には、SOAP リクエスト処理中に発生したエラーの内容が返されます。 SOAP Fault は SOAP メッセージの Envelope 要素の子要素（Body 要素）の唯一の子要素として存在します。

SOAP Fault は、faultcode 要素、faultstring 要素、faultactor 要素、detail 要素の順に 4 つの子要素から構成されます。

faultcode 要素には、以下の何れかの SOAP 違反コード（SOAP Fault Code）が設定されます。

	SOAP Fault
	Simple Object Access Protocol (SOAP) 1.1 ( W3C ) : SOAP Fault SOAP Tutorial : SOAP Fault Element

※ SophiaFramework UNIVERSE では、SOAP Fault は SOAP 1.1 だけがサポートされます。

参照

SFXSOAPRPC::FAULT | SFXSOAPParser::GetFaultActor | SFXSOAPParser::GetFaultCode | SFXSOAPParser::GetFaultDetail | SFXSOAPParser::GetFaultString

戻り値

SOAP Fault 要素の faultactor 要素（Element ノード）

解説

この関数は、SOAP メッセージの Fault 要素（SOAP Fault）の faultactor 要素を取得します。

faultactor 要素には、エラーの発生元 ( URI ) が返されます。

	SOAP Fault
	Simple Object Access Protocol (SOAP) 1.1 ( W3C ) : SOAP Fault SOAP Tutorial : SOAP Fault Element

※ SophiaFramework UNIVERSE では、SOAP Fault は SOAP 1.1 だけがサポートされます。

参照

SFXSOAPParser::GetFault | SFXSOAPParser::GetFaultCode | SFXSOAPParser::GetFaultDetail | SFXSOAPParser::GetFaultString

戻り値

SOAP Fault 要素の faultcode 要素（Element ノード）

解説

この関数は、SOAP メッセージの Fault 要素（SOAP Fault）の faultcode 要素を取得します。

faultactor 要素には、SOAP Fault code が返されます。 SOAP Fault code は、SOAP レスポンスを受け取ったアプリケーションが SOAP リクエスト中に発生したエラー内容を判断するためのコードです。

faultcode 要素には、以下の何れかのエラーコードが設定されます。

	SOAP Fault
	Simple Object Access Protocol (SOAP) 1.1 ( W3C ) : SOAP Fault SOAP Tutorial : SOAP Fault Element

※ SophiaFramework UNIVERSE では、SOAP Fault は SOAP 1.1 だけがサポートされます。

参照

SFXSOAPParser::GetFault | SFXSOAPParser::GetFaultActor | SFXSOAPParser::GetFaultDetail | SFXSOAPParser::GetFaultString

戻り値

SOAP Fault 要素の detail 要素（Element ノード）

解説

この関数は、SOAP メッセージの Fault 要素（SOAP Fault）の detail 要素を取得します。

detail 要素には、エラーの内容が返されます。 faultstring 要素と違うのは、 アプリケーションで処理するためのエラーメッセージとして返される点です。

	SOAP Fault
	Simple Object Access Protocol (SOAP) 1.1 ( W3C ) : SOAP Fault SOAP Tutorial : SOAP Fault Element

※ SophiaFramework UNIVERSE では、SOAP Fault は SOAP 1.1 だけがサポートされます。

参照

SFXSOAPParser::GetFault | SFXSOAPParser::GetFaultActor | SFXSOAPParser::GetFaultCode | SFXSOAPParser::GetFaultString

戻り値

SOAP Fault 要素の faultstring 要素（Element ノード）

解説

この関数は、SOAP メッセージの Fault 要素（SOAP Fault）の faultstring 要素を取得します。

faultstring 要素には、エラーの内容が返されます。 detail 要素と違うのは、人間が理解できるエラーメッセージとして返される点です。

	SOAP Fault
	Simple Object Access Protocol (SOAP) 1.1 ( W3C ) : SOAP Fault SOAP Tutorial : SOAP Fault Element

※ SophiaFramework UNIVERSE では、SOAP Fault は SOAP 1.1 だけがサポートされます。

参照

SFXSOAPParser::GetFault | SFXSOAPParser::GetFaultActor | SFXSOAPParser::GetFaultCode | SFXSOAPParser::GetFaultDetail

戻り値

SOAP メッセージの Header 要素（Element ノード）

解説

この関数は、SOAP メッセージの Header 要素（SOAP Header）を取得します。

参照

SFXSOAPParser::GetEnvelope | SFXSOAPParser::GetBody | SFXSOAPParser::GetHeaderEntries | SFXSOAPParser::GetHeaderEntry

戻り値

SOAP メッセージの Header 要素のすべての子要素

解説

この関数は、SOAP メッセージの Header 要素（SOAP Header）のすべての子要素を取得します。

SOAP メッセージの Header 要素に含まれる、 すべての子要素を SFXXMLNode::DOMNodeList へのポインタとして返します。

子要素がないときは null を返します。

参照

SFXXMLNode::DOMNodeList | SFXSOAPParser::GetHeader | SFXSOAPParser::GetHeaderEntry

戻り値

SOAP メッセージの Header 要素の指定された子要素

解説

この関数は、SOAP メッセージの Header 要素（SOAP Header）の指定された子要素を取得します。

local 引数には要素のローカル名、uri 引数には要素の名前空間 URI を指定します。

	前提条件
	この関数を使用するには、 SFXXMLDOMParser::SetDoNamespaces 関数を使用して名前空間を処理する設定にする必要があります。

参照

SFXXMLDOMParser::SetDoNamespaces | SFXSOAPParser::GetHeader | SFXSOAPParser::GetHeaderEntries

戻り値

SOAP メッセージの Body 要素（SOAP Body）の各子要素の第 1 子要素の中から指定されたパラメータと一致する最初の要素（Element ノード）

解説

この関数は、SOAP メッセージの Body 要素（SOAP Body）の各子要素の第 1 子要素の中から指定されたパラメータと一致する最初の要素を取得します。

local 引数には要素のローカル名、uri 引数には要素の名前空間 URI を指定します。

	前提条件
	この関数を使用するには、 SFXXMLDOMParser::SetDoNamespaces 関数を使用して名前空間を処理する設定にする必要があります。

使用例

解析対象のSOAP メッセージは、 上にある SFXSOAPParser クラスの説明で記述されているものです。

SFXSOAPParser soapparser;   // SOAP パーサー

// GetRPCParameter 関数で 2001 年の価格（"http://example.org/2001/06/quotes":Price）を取得する
// この要素ポインタは 1 番目の "GetLastTradePriceResponse" 要素の 1 番目の子要素 "Price" を指す
SFXXMLElementPtr price = soapparser.GetRPCParameter("Price", "http://example.org/2001/06/quotes");

// 価格を表示する
// price : 34.5
TRACE("price : %s",price->GetText().GetCString());   

参照

SFXXMLDOMParser::SetDoNamespaces | SFXSOAPParser::GetRPCStruct | SFXSOAPParser::GetRPCResult

戻り値

SOAP メッセージの Body 要素の第 1 子要素の第 1 子要素（Element ノード）

解説

この関数は、SOAP メッセージの Body 要素（SOAP Body）の第 1 子要素の第 1 子要素を取得します。

使用例

解析対象のSOAP メッセージは、 上にある SFXSOAPParser クラスの説明で記述されているものです。

SFXSOAPParser soapparser;// SOAP パーサー

// Body 要素の第 1 子要素の第 1 子要素である "Price" 要素を取得する
SFXXMLElementPtr price = soapparser.GetRPCResult();

// 価格を表示する
// price : 34.5
TRACE("price : %s",price->GetText().GetCString());  

参照

SFXSOAPParser::GetRPCStruct | SFXSOAPParser::GetRPCParameter

戻り値

SOAP メッセージの Body 要素の第 1 子要素

解説

この関数は、SOAP メッセージの Body 要素（SOAP Body）の第 1 子要素を取得します。

使用例

解析対象のSOAP メッセージは、 上にある SFXSOAPParser クラスの説明で記述されているものです。

SFXSOAPParser soapparser;   // SOAP パーサー

// Body 要素の第 1 子要素である "m:GetLastTradePriceResponse" 要素を取得する
SFXXMLElementPtr elem = soapparser.GetRPCStruct();

// "m:GetLastTradePriceResponse" 要素の第 1 子要素である "Price" 要素を取得する
SFXXMLElementPtr price = static_cast<SFXXMLElementPtr>(elem->GetFirstChild());

// 価格を表示する
// price : 34.5
TRACE("price : %s",price->GetText().GetCString());   

参照

SFXSOAPParser::GetRPCResult | SFXSOAPParser::GetRPCParameter

戻り値

SOAP メッセージのバージョン

解説

この関数は、SOAP メッセージのバージョンを取得します。

参照

SFXSOAPParser::SOAP_VERSION

戻り値

SOAP メッセージの解析後、 static_exception::static_catch 関数により取得できる、その他のエラー値は以下の通りです。

DTD 付き SOAP メッセージの解析結果のエラーコードは以下の通りです。

スキーマ付き SOAP メッセージの解析結果のエラーコードは以下の通りです。

詳細情報: SFCErrorEnum

解説

この関数は、SOAP メッセージ（ファイル、ストリーム、文字列）を読み込み、DOM 方式で解析します。

引数にはストリーム、ファイルパス、文字列を渡します。 ファイルパスのデフォルト ディレクトリはアプリのホームディレクトリです。

	注意
	BREW の制約により、ファイルの絶対パスは 64 文字より小さくなければいけません。 また、携帯端末内のローカルファイルを指定する必要があります（サーバーのファイルは指定できません）。

参照

static_exception::static_catch | SFCErrorEnum

解説

この関数は、この XML パーサーが使用している、 すべての内部変数をリセットします。

参照

SFXSOAPParser::~SFXSOAPParser

解説

SOAP プロトコルのバージョンを表す定数です。

	注意
	SFXSOAPParser クラスはバージョン 1.1 と 1.2 をサポートしています。 但し、SOAP Attachment は未実装です。

参照

SFXSOAPWriter::SetEnvelope | SFXSOAPParser::GetSoapVersion