第三十六章 添加和使用自定义标题元素 - 指定 XData 块中支持的标头元素

37 阅读2分钟

第三十六章 添加和使用自定义标题元素 - 指定 XData 块中支持的标头元素

指定 XData 块中支持的标头元素

如果使用 SOAP 向导根据给定的 WSDL 创建 Web 服务或 Web 客户端,系统将在该类中生成一个 XData 块来表示其 SOAP 消息中支持的任何标头元素。(有关 SOAP 向导的信息,请参阅使用 SOAP 向导。)

如果手动创建 Web 服务或客户端,则必须手动指定此 XData 块。

以下是一个简单的例子:

XData NewXData1
{
<parameters xmlns="https://www.intersystems.com/configuration">
   <request>
      <header name="ServiceHeader" class="NewHeaders.MyCustomHeader"/> 
   </request>
   <response>
      <header name="ExpectedClientHeader" class="NewHeaders.MyCustomHeader"/> 
   </response>
</parameters>
}

Details

XData 块的要求如下:

  • XData 块可以有任意名称。名称(本例中为 NewXData1)未被使用。

SOAP 向导在创建此块时使用名称参数。

  • 顶级元素必须是 <parameters>
  • <parameters> 元素及其所有子元素(及其子元素)必须位于命名空间“https://www.intersystems.com/configuration”中
  • <parameters> 元素可以具有以下子元素:

<request> — 确定与所有请求消息关联的标头元素,对于所有请求消息中都应该相同的标头元素。

对于每个适用的标题元素,此元素应该有一个子元素<header>

<response> — 确定与所有响应消息关联的标头元素,对于所有响应消息中都应该相同的标头元素。

对于每个适用的标题元素,此元素应该有一个子元素 <header>

<methodname> — 确定与名称为 methodnameWeb 方法关联的标头元素。

该元素可以具有以下子元素:

  • <header> — 确定与此 Web 方法的请求和响应消息关联的标头元素,对于任何在两种情况下都应该相同的标头元素。
  • <request> — 确定与此 Web 方法的请求消息关联的标头元素。

对于每个适用的标题元素,此元素应该有一个子元素

  • <response> — 确定与此 Web 方法的响应消息相关的标头元素。

对于每个适用的标题元素,此元素应该有一个子元素 <header>

在此 XData 块中,每个 <header> 元素将一个 header 元素与应用于表示它的 IRIS 类相关联。此元素包括以下属性:

AttributePurpose
name标题元素的名称。
class代表此标题元素的IRIS 类。
alias(可选)Web 服务或 Web 客户端的 HeadersIn 数组中此标头元素的键。默认值为 name 属性指定的值。

XData 块内 <header> 元素的位置指示它适用的消息。