SOAP 请求标头管理

SOAP 请求标头是一个 SOAP 封装中的 XML 片段。当 SOAP 操作及其参数可以被看作远程过程调用 (Remote Procedure Call，RPC) 时，SOAP 请求标头可用于在特定的请求或响应中传输元信息。SOAP 请求标头传输应用程序的元数据，如授权或会话标准。

SOAPHEADER 子句的值必须是有效并符合 SOAP 请求标头条目的 XML 片段。可以指定多个 SOAP 请求标头条目。存储过程或函数将 SOAP 请求标头条目自动注入 SOAP 标头元素中 (SOAP-ENV:Header)。SOAPHEADER 值指定可声明为静态常量或使用参数替代机制进行动态设置的 SOAP 标头。以下是一个 SOAP 请求示例的代码段。它包含两个 XML 标头，分别称为 Authentication 和 Session。

<?xml version="1.0"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:m="HTTP://localhost:8082">
  <SOAP-ENV:Header>
    <Authentication xmlns="CustomerOrderURN">
      <userName pwd="none" mustUnderstand="1">
        <first>John</first>
        <last>Smith</last>
      </userName>
    </Authentication>
    <Session xmlns="SomeSession">123456789</Session>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <m:SoapOperation>
      <m:intVariable>123</m:intVariable>
      <m:charVariable>data</m:charVariable>
    </m:SoapOperation>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

函数和过程在处理 SOAP 响应标头（由 SOAP 调用返回）上是不同的。使用函数是最灵活也是建议采用的方法，此时将被接收到整个 SOAP 响应封装。响应封装就可以通过 OPENXML 运算符进行处理，从而抽取 SOAP 标头和 SOAP 主体数据。而使用过程时，SOAP 响应标头只能通过用映射到 IN 或 INOUT 变量的替代参数来抽取。SOAP 过程允许的 IN 或 INOUT 参数的最大数量为一个。

Web 服务函数必须分析响应 SOAP 封装以获得标头条目。

示例

以下示例说明了如何创建发送参数和 SOAP 标头的 SOAP 过程和函数。使用包装过程来填充 Web 服务过程调用，并处理响应。soapAddItemProc 过程说明了 SOAP Web 服务过程的使用，soapAddItemFunc 函数说明了 SOAP Web 服务函数的使用，而 httpAddItemFunc 函数则说明了 SOAP 载荷如何被传递到 HTTP Web 服务过程。

下例说明了使用替代参数发送 SOAP 标头的 SOAP 客户端过程。可使用单个 INOUT 参数来接收 SOAP 标头。调用 soapAddItemProc 的包装存储过程 addItemProcWrapper 演示了如何发送和接收包括参数的 SOAP 标头。

CREATE PROCEDURE soapAddItemProc(amount INT, item LONG VARCHAR, 
        INOUT inoutheader LONG VARCHAR, IN inheader LONG VARCHAR)
    URL 'http://localhost:8082/itemStore'
    SET 'SOAP( OP=addItems )'
    TYPE 'SOAP:DOC'
    SOAPHEADER '!inoutheader!inheader';

CREATE PROCEDURE addItemProcWrapper(amount INT, item LONG VARCHAR, 
        first_name LONG VARCHAR, last_name LONG VARCHAR)
BEGIN
    DECLARE io_header LONG VARCHAR;     // inout (write/read) soap header
    DECLARE resxml LONG VARCHAR;
    DECLARE soap_header_sent LONG VARCHAR;
    DECLARE i_header LONG VARCHAR;      // in (write) only soap header
    DECLARE err int;
    DECLARE crsr CURSOR FOR 
        CALL soapAddItemProc( amount, item, io_header, i_header );

    SET io_header = XMLELEMENT( 'Authentication',
                        XMLATTRIBUTES('CustomerOrderURN' as xmlns),
                        XMLELEMENT('userName', XMLATTRIBUTES(
                                        'none' as pwd,
                                        '1' as mustUnderstand ),
                            XMLELEMENT( 'first', first_name ),
                            XMLELEMENT( 'last', last_name ) ) );
    SET i_header = '<Session xmlns="SomeSession">123456789</Session>';
    SET soap_header_sent = io_header || i_header;
    OPEN crsr;
    FETCH crsr INTO resxml, err;
    CLOSE crsr;

    SELECT resxml, err, soap_header_sent, io_header AS soap_header_received;
END;

/* example call to addItemProcWrapper */
CALL addItemProcWrapper( 5, 'shirt', 'John', 'Smith' );

下例说明了使用替代参数发送 SOAP 标头的 SOAP 客户端函数。返回整个 SOAP 响应封装。可使用 OPENXML 运算符分析 SOAP 标头。调用 soapAddItemFunc 的包装函数 addItemFuncWrapper 演示了如何发送和接收包括参数的 SOAP 标头。它也显示了如何使用 OPENXML 运算符处理响应。

CREATE FUNCTION soapAddItemFunc(amount INT, item LONG VARCHAR, 
        IN inheader1 LONG VARCHAR, IN inheader2 LONG VARCHAR )
    RETURNS XML
    URL 'http://localhost:8082/itemStore'
    SET 'SOAP(OP=addItems)'
    TYPE 'SOAP:DOC'
    SOAPHEADER '!inheader1!inheader2';

CREATE PROCEDURE addItemFuncWrapper(amount INT, item LONG VARCHAR, 
        first_name LONG VARCHAR, last_name LONG VARCHAR )
BEGIN
    DECLARE i_header1 LONG VARCHAR;
    DECLARE i_header2 LONG VARCHAR;
    DECLARE res LONG VARCHAR;
    DECLARE ns LONG VARCHAR;
    DECLARE xpath LONG VARCHAR;
    DECLARE header_entry LONG VARCHAR;
    DECLARE localname LONG VARCHAR;
    DECLARE namespaceuri LONG VARCHAR;
    DECLARE r_quantity int;
    DECLARE r_item LONG VARCHAR;
    DECLARE r_status LONG VARCHAR;

    SET i_header1 = XMLELEMENT( 'Authentication',
                        XMLATTRIBUTES('CustomerOrderURN' as xmlns),
                        XMLELEMENT('userName', XMLATTRIBUTES(
                                        'none' as pwd,
                                        '1' as mustUnderstand ),
                            XMLELEMENT( 'first', first_name ),
                            XMLELEMENT( 'last',  last_name ) ) );
    SET i_header2 = '<Session xmlns="SessionURN">123456789</Session>';

    SET res = soapAddItemFunc( amount, item, i_header1, i_header2 );

    SET ns = '<ns xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"'
            || ' xmlns:mp="urn:ianywhere-com:sa-xpath-metaprop"'
            || ' xmlns:customer="CustomerOrderURN"'
            || ' xmlns:session="SessionURN"'
            || ' xmlns:tns="http://localhost:8082"></ns>';

    // Process headers...            
    SET xpath = '//SOAP-ENV:Header/*';
    BEGIN
         DECLARE crsr CURSOR FOR SELECT * FROM
                 OPENXML( res, xpath, 1, ns )
                      WITH (  "header_entry" LONG VARCHAR '@mp:xmltext',
                              "localname"    LONG VARCHAR '@mp:localname',
                              "namespaceuri" LONG VARCHAR '@mp:namespaceuri' );
        OPEN crsr;
        FETCH crsr INTO "header_entry", "localname", "namespaceuri";
        CLOSE crsr;
    END;

    // Process body...
    SET xpath = '//tns:row';
    BEGIN
         DECLARE crsr1 CURSOR FOR SELECT * FROM
                 OPENXML( res, xpath, 1, ns )
                      WITH (  "r_quantity" INT 'tns:quantity/text()',
                              "r_item"     LONG VARCHAR 'tns:item/text()',
                              "r_status"   LONG VARCHAR 'tns:status/text()' );
        OPEN crsr1;
        FETCH crsr1 INTO "r_quantity", "r_item", "r_status";
        CLOSE crsr1;
    END;

    SELECT r_item, r_quantity, r_status, header_entry, localname, namespaceuri;
END;

/* example call to addItemFuncWrapper */
CALL addItemFuncWrapper( 6, 'shorts', 'Jack', 'Smith' );

下例演示了如何才能使用 HTTP:POST 传输整个 SOAP 载荷。此方法创建了传输 SOAP 载荷的 Web 服务 HTTP 过程，而不是 Web 服务客户端 SOAP 过程。包装过程 addItemHttpWrapper 调用 httpAddItemFunc 演示 POST 函数的使用方法。它显示了如何发送和接收包括参数的 SOAP 标头以及如何接收响应。

CREATE FUNCTION httpAddItemFunc(soapPayload XML)
    RETURNS XML
    URL 'http://localhost:8082/itemStore'
    TYPE 'HTTP:POST:text/xml'
    HEADER 'SOAPAction: "http://localhost:8082/addItems"';

CREATE PROCEDURE addItemHttpWrapper(amount INT, item LONG VARCHAR)
RESULT(response XML)
BEGIN
    DECLARE payload XML;
    DECLARE response XML;

    SET payload =
'<?xml version="1.0"?>
<SOAP-ENV:Envelope
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:m="http://localhost:8082">
  <SOAP-ENV:Body>
    <m:addItems>
      <m:amount>' || amount || '</m:amount>
      <m:item>' || item || '</m:item>
    </m:addItems>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>';

    SET response = httpAddItemFunc( payload );
    /* process response as demonstrated in addItemFuncWrapper */
    SELECT response;
END;

/* example call to addItemHttpWrapper */
CALL addItemHttpWrapper( 7, 'socks' );

有关在服务器端实现本示例的信息，请参见如何访问客户端提供的 SOAP 请求标头。

限制

使用DocCommentXchange讨论此页。